npm install easymde

<linkrel="stylesheet"href="https://unpkg.com/easymde/dist/easymde.min.css"><scriptsrc="https://unpkg.com/easymde/dist/easymde.min.js"></script>

<linkrel="stylesheet"href="https://cdn.jsdelivr.net/npm/easymde/dist/easymde.min.css"><scriptsrc="https://cdn.jsdelivr.net/npm/easymde/dist/easymde.min.js"></script>

<textarea></textarea><script>consteasyMDE=newEasyMDE();</script>

<textareaid="my-text-area"></textarea><script>consteasyMDE=newEasyMDE({element:document.getElementById('my-text-area')});</script>

UseeasyMDE.value() to get the content of the editor:

<script>easyMDE.value();</script>

UseeasyMDE.value(val) to set the content of the editor:

<script>easyMDE.value('New input for **EasyMDE**');</script>

• autoDownloadFontAwesome: If set totrue, force downloads Font Awesome (used for icons). If set tofalse, prevents downloading. Defaults toundefined, which will intelligently check whether Font Awesome has already been included, then download accordingly.
• autofocus: If set totrue, focuses the editor automatically. Defaults tofalse.
• autosave:Saves the text that's being written and will load it back in the future. It will forget the text when the form it's contained in is submitted.
  • enabled: If set totrue, saves the text automatically. Defaults tofalse.
  • delay: Delay between saves, in milliseconds. Defaults to10000 (10 seconds).
  • submit_delay: Delay before assuming that submit of the form failed and saving the text, in milliseconds. Defaults toautosave.delay or10000 (10 seconds).
  • uniqueId: You must set a unique string identifier so that EasyMDE can autosave. Something that separates this from other instances of EasyMDE elsewhere on your website.
  • timeFormat: Set DateTimeFormat. More information seeDateTimeFormat instances. Defaultlocale: en-US, format: hour:minute.
  • text: Set text for autosave.
• autoRefresh: Useful, when initializing the editor in a hidden DOM node. If set to{ delay: 300 }, it will check every 300 ms if the editor is visible and if positive, call CodeMirror'srefresh().
• blockStyles: Customize how certain buttons that style blocks of text behave.
  • bold: Can be set to** or__. Defaults to**.
  • code: Can be set to``` or~~~. Defaults to```.
  • italic: Can be set to* or_. Defaults to*.
• unorderedListStyle: can be*,- or+. Defaults to*.
• scrollbarStyle: Chooses a scrollbar implementation. The default is "native", showing native scrollbars. The core library also provides the "null" style, which completely hides the scrollbars. Addons can implement additional scrollbar models.
• element: The DOM element for thetextarea element to use. Defaults to the firsttextarea element on the page.
• forceSync: If set totrue, force text changes made in EasyMDE to be immediately stored in original text area. Defaults tofalse.
• hideIcons: An array of icon names to hide. Can be used to hide specific icons shown by default without completely customizing the toolbar.
• indentWithTabs: If set tofalse, indent using spaces instead of tabs. Defaults totrue.
• initialValue: If set, will customize the initial value of the editor.
• previewImagesInEditor: - EasyMDE will show preview of images,false by default, preview for images will appear only for images on separate lines.
• imagesPreviewHandler: - A custom function for handling the preview of images. Takes the parsed string between the parantheses of the image markdown![]( ) as argument and returns a string that serves as thesrc attribute of the<img> tag in the preview. Enables dynamic previewing of images in the frontend without having to upload them to a server, allows copy-pasting of images to the editor with preview.
• insertTexts: Customize how certain buttons that insert text behave. Takes an array with two elements. The first element will be the text inserted before the cursor or highlight, and the second element will be inserted after. For example, this is the default link value:["[", "](http://)"].
  • horizontalRule
  • image
  • link
  • table
• lineNumbers: If set totrue, enables line numbers in the editor.
• lineWrapping: If set tofalse, disable line wrapping. Defaults totrue.
• minHeight: Sets the minimum height for the composition area, before it starts auto-growing. Should be a string containing a valid CSS value like"500px". Defaults to"300px".
• maxHeight: Sets fixed height for the composition area.minHeight option will be ignored. Should be a string containing a valid CSS value like"500px". Defaults toundefined.
• onToggleFullScreen: A function that gets called when the editor's full screen mode is toggled. The function will be passed a boolean as parameter,true when the editor is currently going into full screen mode, orfalse.
• parsingConfig: Adjust settings for parsing the Markdown during editing (not previewing).
  • allowAtxHeaderWithoutSpace: If set totrue, will render headers without a space after the#. Defaults tofalse.
  • strikethrough: If set tofalse, will not process GFM strikethrough syntax. Defaults totrue.
  • underscoresBreakWords: If set totrue, let underscores be a delimiter for separating words. Defaults tofalse.
• overlayMode: Pass a custom codemirroroverlay mode to parse and style the Markdown during editing.
  • mode: A codemirror mode object.
  • combine: If set tofalse, willreplace CSS classes returned by the default Markdown mode. Otherwise the classes returned by the custom mode will be combined with the classes returned by the default mode. Defaults totrue.
• placeholder: If set, displays a custom placeholder message.
• previewClass: A string or array of strings that will be applied to the preview screen when activated. Defaults to"editor-preview".
• previewRender: Custom function for parsing the plaintext Markdown and returning HTML. Used when user previews.
• promptURLs: If set totrue, a JS alert window appears asking for the link or image URL. Defaults tofalse.
• promptTexts: Customize the text used to prompt for URLs.
  • image: The text to use when prompting for an image's URL. Defaults toURL of the image:.
  • link: The text to use when prompting for a link's URL. Defaults toURL for the link:.
• iconClassMap: Used to specify the icon class names for the various toolbar buttons.
• uploadImage: If set totrue, enables the image upload functionality, which can be triggered by drag and drop, copy-paste and through the browse-file window (opened when the user click on theupload-image icon). Defaults tofalse.
• imageMaxSize: Maximum image size in bytes, checked before upload (note: never trust client, always check the image size at server-side). Defaults to1024 * 1024 * 2 (2 MB).
• imageAccept: A comma-separated list of mime-types used to check image type before upload (note: never trust client, always check file types at server-side). Defaults toimage/png, image/jpeg.
• imageUploadFunction: A custom function for handling the image upload. Using this function will render the optionsimageMaxSize,imageAccept,imageUploadEndpoint andimageCSRFToken ineffective.
  • The function gets a file andonSuccess andonError callback functions as parameters.onSuccess(imageUrl: string) andonError(errorMessage: string)
• imageUploadEndpoint: The endpoint where the images data will be sent, via an asynchronousPOST request. The server is supposed to save this image, and return a JSON response.
  • if the request was successfully processed (HTTP 200 OK):{"data": {"filePath": "<filePath>"}} wherefilePath is the path of the image (absolute ifimagePathAbsolute is set to true, relative if otherwise);
  • otherwise:{"error": "<errorCode>"}, whereerrorCode can benoFileGiven (HTTP 400 Bad Request),typeNotAllowed (HTTP 415 Unsupported Media Type),fileTooLarge (HTTP 413 Payload Too Large) orimportError (seeerrorMessages below). IferrorCode is not one of theerrorMessages, it is alerted unchanged to the user. This allows for server-side error messages.No default value.
• imagePathAbsolute: If set totrue, will treatimageUrl fromimageUploadFunction andfilePath returned fromimageUploadEndpoint as an absolute rather than relative path, i.e. not prependwindow.location.origin to it.
• imageCSRFToken: CSRF token to include with AJAX call to upload image. For various instances like Django, Spring and Laravel.
• imageCSRFName: CSRF token filed name to include with AJAX call to upload image, applied whenimageCSRFToken has value, defaults tocsrfmiddlewaretoken.
• imageCSRFHeader: If set totrue, passing CSRF token via header. Defaults tofalse, which pass CSRF through request body.
• imageTexts: Texts displayed to the user (mainly on the status bar) for the import image feature, where#image_name#,#image_size# and#image_max_size# will replaced by their respective values, that can be used for customization or internationalization:
  • sbInit: Status message displayed initially ifuploadImage is set totrue. Defaults toAttach files by drag and dropping or pasting from clipboard..
  • sbOnDragEnter: Status message displayed when the user drags a file to the text area. Defaults toDrop image to upload it..
  • sbOnDrop: Status message displayed when the user drops a file in the text area. Defaults toUploading images #images_names#.
  • sbProgress: Status message displayed to show uploading progress. Defaults toUploading #file_name#: #progress#%.
  • sbOnUploaded: Status message displayed when the image has been uploaded. Defaults toUploaded #image_name#.
  • sizeUnits: A comma-separated list of units used to display messages with human-readable file sizes. Defaults to B, KB, MB (example:218 KB). You can useB,KB,MB instead if you prefer without whitespaces (218KB).
• errorMessages: Errors displayed to the user, using theerrorCallback option, where#image_name#,#image_size# and#image_max_size# will replaced by their respective values, that can be used for customization or internationalization:
  • noFileGiven: The server did not receive any file from the user. Defaults toYou must select a file..
  • typeNotAllowed: The user send a file type which doesn't match theimageAccept list, or the server returned this error code. Defaults toThis image type is not allowed..
  • fileTooLarge: The size of the image being imported is bigger than theimageMaxSize, or if the server returned this error code. Defaults toImage #image_name# is too big (#image_size#).\nMaximum file size is #image_max_size#..
  • importError: An unexpected error occurred when uploading the image. Defaults toSomething went wrong when uploading the image #image_name#..
• errorCallback: A callback function used to define how to display an error message. Defaults to(errorMessage) => alert(errorMessage).
• renderingConfig: Adjust settings for parsing the Markdown during previewing (not editing).
  • codeSyntaxHighlighting: If set totrue, will highlight usinghighlight.js. Defaults tofalse. To use this feature you must include highlight.js on your page or pass in using thehljs option. For example, include the script and the CSS files like:
    <script src="https://cdn.jsdelivr.net/highlight.js/latest/highlight.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/highlight.js/latest/styles/github.min.css">
  • hljs: An injectible instance ofhighlight.js. If you don't want to rely on the global namespace (window.hljs), you can provide an instance here. Defaults toundefined.
  • markedOptions: Set the internal Markdown renderer'soptions. OtherrenderingConfig options will take precedence.
  • singleLineBreaks: If set tofalse, disable parsingGitHub Flavored Markdown (GFM) single line breaks. Defaults totrue.
  • sanitizerFunction: Custom function for sanitizing the HTML output of Markdown renderer.
• shortcuts: Keyboard shortcuts associated with this instance. Defaults to thearray of shortcuts.
• showIcons: An array of icon names to show. Can be used to show specific icons hidden by default without completely customizing the toolbar.
• spellChecker: If set tofalse, disable the spell checker. Defaults totrue. Optionally pass a CodeMirrorSpellChecker-compliant function.
• inputStyle:textarea orcontenteditable. Defaults totextarea for desktop andcontenteditable for mobile.contenteditable option is necessary to enable nativeSpellcheck.
• nativeSpellcheck: If set tofalse, disable native spell checker. Defaults totrue.
• sideBySideFullscreen: If set tofalse, allows side-by-side editing without going into fullscreen. Defaults totrue.
• status: If set tofalse, hide the status bar. Defaults to the array of built-in status bar items.
  • Optionally, you can set an array of status bar items to include, and in what order. You can even define your own custom status bar items.
• styleSelectedText: If set tofalse, remove theCodeMirror-selectedtext class from selected lines. Defaults totrue.
• syncSideBySidePreviewScroll: If set tofalse, disable syncing scroll in side by side mode. Defaults totrue.
• tabSize: If set, customize the tab size. Defaults to2.
• theme: Override the theme. Defaults toeasymde.
• toolbar: If set tofalse, hide the toolbar. Defaults to thearray of icons.
• toolbarTips: If set tofalse, disable toolbar button tips. Defaults totrue.
• toolbarButtonClassPrefix: Adds a prefix to the toolbar button classes when set. For example, a value of"mde" results in"mde-bold" for the Bold button.
• direction:rtl orltr. Changes text direction to support right-to-left languages. Defaults toltr.

Most options demonstrate the non-default behavior:

consteditor=newEasyMDE({autofocus:true,autosave:{enabled:true,uniqueId:"MyUniqueID",delay:1000,submit_delay:5000,timeFormat:{locale:'en-US',format:{year:'numeric',month:'long',day:'2-digit',hour:'2-digit',minute:'2-digit',},},text:"Autosaved: "},blockStyles:{bold:"__",italic:"_",},unorderedListStyle:"-",element:document.getElementById("MyID"),forceSync:true,hideIcons:["guide","heading"],indentWithTabs:false,initialValue:"Hello world!",insertTexts:{horizontalRule:["","\n\n-----\n\n"],image:["![](http://",")"],link:["[","](https://)"],table:["","\n\n| Column 1 | Column 2 | Column 3 |\n| -------- | -------- | -------- |\n| Text     | Text      | Text     |\n\n"],},lineWrapping:false,minHeight:"500px",parsingConfig:{allowAtxHeaderWithoutSpace:true,strikethrough:false,underscoresBreakWords:true,},placeholder:"Type here...",previewClass:"my-custom-styling",previewClass:["my-custom-styling","more-custom-styling"],previewRender:(plainText)=>customMarkdownParser(plainText),// Returns HTML from a custom parserpreviewRender:(plainText,preview)=>{// Async methodsetTimeout(()=>{preview.innerHTML=customMarkdownParser(plainText);},250);// If you return null, the innerHTML of the preview will not// be overwritten. Useful if you control the preview node's content via// vdom diffing.// return null;return"Loading...";},promptURLs:true,promptTexts:{image:"Custom prompt for URL:",link:"Custom prompt for URL:",},renderingConfig:{singleLineBreaks:false,codeSyntaxHighlighting:true,sanitizerFunction:(renderedHTML)=>{// Using DOMPurify and only allowing <b> tagsreturnDOMPurify.sanitize(renderedHTML,{ALLOWED_TAGS:['b']})},},shortcuts:{drawTable:"Cmd-Alt-T"},showIcons:["code","table"],spellChecker:false,status:false,status:["autosave","lines","words","cursor"],// Optional usagestatus:["autosave","lines","words","cursor",{className:"keystrokes",defaultValue:(el)=>{el.setAttribute('data-keystrokes',0);},onUpdate:(el)=>{constkeystrokes=Number(el.getAttribute('data-keystrokes'))+1;el.innerHTML=`${keystrokes} Keystrokes`;el.setAttribute('data-keystrokes',keystrokes);},}],// Another optional usage, with a custom status bar item that counts keystrokesstyleSelectedText:false,sideBySideFullscreen:false,syncSideBySidePreviewScroll:false,tabSize:4,toolbar:false,toolbarTips:false,toolbarButtonClassPrefix:"mde",});

Below are the built-in toolbar icons (only some of which are enabled by default), which can be reorganized however you like. "Name" is the name of the icon, referenced in the JavaScript. "Action" is either a function or a URL to open. "Class" is the class given to the icon. "Tooltip" is the small tooltip that appears via thetitle="" attribute. Note that shortcut hints are added automatically and reflect the specified action if it has a key bind assigned to it (i.e. with the value ofaction set tobold and that oftooltip set toBold, the final text the user will see would be "Bold (Ctrl-B)").

Additionally, you can add a separator between any icons by adding"|" to the toolbar array.

Customize the toolbar using thetoolbar option.

Only the order of existing buttons:

consteasyMDE=newEasyMDE({toolbar:["bold","italic","heading","|","quote"]});

All information and/or add your own icons or text

consteasyMDE=newEasyMDE({toolbar:[{name:"bold",action:EasyMDE.toggleBold,className:"fa fa-bold",title:"Bold",},"italic",// shortcut to pre-made button{name:"custom",action:(editor)=>{// Add your own code},className:"fa fa-star",text:"Starred",title:"Custom Button",attributes:{// for custom attributesid:"custom-id","data-value":"custom value"// HTML5 data-* attributes need to be enclosed in quotation marks ("") because of the dash (-) in its name.}},"|"// Separator// [, ...]]});

Put some buttons on dropdown menu

consteasyMDE=newEasyMDE({toolbar:[{name:"heading",action:EasyMDE.toggleHeadingSmaller,className:"fa fa-header",title:"Headers",},"|",{name:"others",className:"fa fa-blind",title:"others buttons",children:[{name:"image",action:EasyMDE.drawImage,className:"fa fa-picture-o",title:"Image",},{name:"quote",action:EasyMDE.toggleBlockquote,className:"fa fa-percent",title:"Quote",},{name:"link",action:EasyMDE.drawLink,className:"fa fa-link",title:"Link",}]},// [, ...]]});

EasyMDE comes with an array of predefined keyboard shortcuts, but they can be altered with a configuration option. The list of default ones is as follows:

Here is how you can change a few, while leaving others untouched:

consteditor=newEasyMDE({shortcuts:{"toggleOrderedList":"Ctrl-Alt-K",// alter the shortcut for toggleOrderedList"toggleCodeBlock":null,// unbind Ctrl-Alt-C"drawTable":"Cmd-Alt-T",// bind Cmd-Alt-T to drawTable action, which doesn't come with a default shortcut}});

Shortcuts are automatically converted between platforms. If you define a shortcut as "Cmd-B", on PC that shortcut will be changed to "Ctrl-B". Conversely, a shortcut defined as "Ctrl-B" will become "Cmd-B" for Mac users.

The list of actions that can be bound is the same as the list of built-in actions available fortoolbar buttons.

You can catch the following list of events:https://codemirror.net/doc/manual.html#events

consteasyMDE=newEasyMDE();easyMDE.codemirror.on("change",()=>{console.log(easyMDE.value());});

You can revert to the initial text area by calling thetoTextArea method. Note that this clears up the autosave (if enabled) associated with it. The text area will retain any text from the destroyed EasyMDE instance.

consteasyMDE=newEasyMDE();// ...easyMDE.toTextArea();easyMDE=null;

If you need to remove registered event listeners (when the editor is not needed anymore), calleasyMDE.cleanup().

The following self-explanatory methods may be of use while developing with EasyMDE.

consteasyMDE=newEasyMDE();easyMDE.isPreviewActive();// returns booleaneasyMDE.isSideBySideActive();// returns booleaneasyMDE.isFullscreenActive();// returns booleaneasyMDE.clearAutosavedValue();// no returned value

EasyMDE is a continuation of SimpleMDE.

SimpleMDE began as an improvement oflepture's Editor project, but has now taken on an identity of its own. It is bundled withCodeMirror and depends onFont Awesome.

CodeMirror is the backbone of the project and parses much of the Markdown syntax as it's being written. This allows us to add styles to the Markdown that's being written. Additionally, a toolbar and status bar have been added to the top and bottom, respectively. Previews are rendered byMarked using GitHub Flavored Markdown (GFM).

I originally made this fork to implement FontAwesome 5 compatibility into SimpleMDE. When that was done I submitted apull request, which has not been accepted yet. This, and the project being inactive since May 2017, triggered me to make more changes and try to put new life into the project.

Changes include:

• FontAwesome 5 compatibility
• Guide button works when editor is in preview mode
• Links are nowhttps:// by default
• Small styling changes
• Support for Node 8 and beyond
• Lots of refactored code
• Links in preview will open in a new tab by default
• TypeScript support

My intention is to continue development on this project, improving it and keeping it alive.

You may want to edit this library to adapt its behavior to your needs. This can be done in some quick steps:

1. Follow theprerequisites andinstallation instructions in the contribution guide;
2. Do your changes;
3. Rungulp command, which will generate files:dist/easymde.min.css anddist/easymde.min.js;
4. Copy-paste those files to your code base, and you are done.

Want to contribute to EasyMDE? Thank you! We have acontribution guide just for you!

This project is released under theMIT License.

• Copyright (c) 2015 Sparksuite, Inc.
• Copyright (c) 2017 Jeroen Akkerman.