easy-markdown-editor/README.md

# EasyMDE - Markdown Editor

[![npm version](https://img.shields.io/npm/v/easymde.svg?style=for-the-badge)](https://www.npmjs.com/package/easymde)
[![npm version](https://img.shields.io/npm/v/easymde/next.svg?style=for-the-badge)](https://www.npmjs.com/package/easymde/v/next)
[![Build Status](https://img.shields.io/travis/Ionaru/easy-markdown-editor/development.svg?style=for-the-badge)](https://travis-ci.org/Ionaru/easy-markdown-editor)

> This repository is a fork of
[SimpleMDE, made by Sparksuite](https://github.com/sparksuite/simplemde-markdown-editor/).
Go to the [dedicated section](#simplemde-fork) for more information.

A drop-in JavaScript *textarea* replacement for writing beautiful and
understandable Markdown. The WYSIWYG-esque editor allows users who may be less
experienced with Markdown to use familiar toolbar buttons and shortcuts.

In addition, the syntax is rendered while editing to clearly show the expected
result. Headings are larger, emphasized words are italicized, links are
underlined, etc. EasyMDE is one of the first editors to feature both built-in
auto-saving and spell checking.

Try [**the demo**](https://easymde.tk/)!

[![Preview](./doc/screenshot.png)](https://easymde.tk/)


## Quick access

- [Why not a WYSIWYG editor or pure Markdown?](#why-not-a-wysiwyg-editor-or-pure-markdown)
- [Install EasyMDE](#install-easymde)
- [How to use](#how-to-use)
  - [Loading the editor](#loading-the-editor)
  - [Editor functions](#editor-functions)
- [Configuration](#configuration)
  - [Options list](#options-list)
  - [Options example](#options-example)
  - [Toolbar icons](#toolbar-icons)
  - [Toolbar customization](#toolbar-customization)
  - [Keyboard shortcuts](#keyboard-shortcuts)
- [Advanced use](#advanced-use)
  - [Event handling](#event-handling)
  - [Removing EasyMDE from text area](#removing-easymde-from-text-area)
  - [Useful methods](#useful-methods)
- [How it works](#how-it-works)
- [SimpleMDE fork](#simplemde-fork)
- [License](#license)

## Why not a WYSIWYG editor or pure Markdown?

WYSIWYG editors that produce HTML are often complex and buggy. Markdown solves
this problem in many ways, plus Markdown can be rendered natively on more
platforms than HTML.

However, Markdown is not a syntax that an average user will
be familiar with, nor is it visually clear while editing. In other words, for an
unfamiliar user, the syntax they write will make little sense until they click
the preview button. EasyMDE has been designed to bridge this gap for
non-technical users who are less familiar with or just learning Markdown syntax.


## Install EasyMDE

Via [npm](https://www.npmjs.com/package/easymde):

```
npm install easymde --save
```

Via the *UNPKG* CDN:

```html
<link rel="stylesheet" href="https://unpkg.com/easymde/dist/easymde.min.css">
<script src="https://unpkg.com/easymde/dist/easymde.min.js"></script>
```


## How to use


### Loading the editor

After installing and/or importing the module, you can load EasyMDE onto the
first TextArea on the web page:

```html
<textarea></textarea>
<script>
var easyMDE = new EasyMDE();
</script>
```

Alternatively you can select a specific TextArea, via Javascript:

```html
<textarea id="my-text-area"></textarea>
<script>
var easyMDE = new EasyMDE({element: document.getElementById('my-text-area')});
</script>
```

Or via jQuery:

```html
<textarea id="my-text-area"></textarea>
<script>
var easyMDE = new EasyMDE({element: $('#my-text-area')[0]});
</script>
```


### Editor functions

Use `EasyMDE.value()` to get the content of the editor:

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

Use `EasyMDE.value(val)` to set the content of the editor:

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


## Configuration

### Options list

- **autoDownloadFontAwesome**: If set to `true`, force downloads Font Awesome
(used for icons). If set to `false`, prevents downloading. Defaults to
`undefined`, which will intelligently check whether Font Awesome has already
been included, then download accordingly.
- **autofocus**: If set to `true`, auto-focuses the editor. Defaults to `false`.
- **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 to `true`, auto-save the text. Defaults to `false`.
  - **delay**: Delay between saves, in milliseconds. Defaults to `10000` (10s).
  - **uniqueId**: You must set a unique string identifier so that EasyMDE can
auto-save. Something that separates this from other instances of EasyMDE
elsewhere on your website.
- **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 `*`.
- **element**: The DOM element for the text area to use. Defaults to the first
text area on the page.
- **forceSync**: If set to `true`, force text changes made in EasyMDE to be
immediately stored in original text area. Defaults to `false`.
- **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 to `false`, indent using spaces instead of tabs.
Defaults to `true`.
- **initialValue**: If set, will customize the initial value of the editor.
- **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
- **lineWrapping**: If set to `false`, disable line wrapping. Defaults to `true`.
- **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"`.
- **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, or `false`.
- **parsingConfig**: Adjust settings for parsing the Markdown during editing
(not previewing).
  - **allowAtxHeaderWithoutSpace**: If set to `true`, will render headers
without a space after the `#`. Defaults to `false`.
  - **strikethrough**: If set to `false`, will not process GFM strikethrough
syntax. Defaults to `true`.
  - **underscoresBreakWords**: If set to `true`, let underscores be a delimiter
for separating words. Defaults to `false`.
- **placeholder**: If set, displays a custom placeholder message.
- **previewRender**: Custom function for parsing the plaintext Markdown and
returning HTML. Used when user previews.
- **promptURLs**: If set to `true`, a JS alert window appears asking for the
link or image URL. Defaults to `false`.
- **promptTexts**: Customize the text used to prompt for URLs.
  - **image**: The text to use when prompting for an image's URL.  Defaults to
`URL of the image:`.
  - **link**: The text to use when prompting for a link's URL. Defaults to
`URL for the link:`.
- **renderingConfig**: Adjust settings for parsing the Markdown during
previewing (not editing).
  - **codeSyntaxHighlighting**: If set to `true`, will highlight using
[highlight.js](https://github.com/isagalaev/highlight.js). Defaults to `false`.
To use this feature you must include highlight.js on your page or pass in using
the `hljs` option. For example, include the script and the CSS files like:
<br>`<script src="https://cdn.jsdelivr.net/highlight.js/latest/highlight.min.js"></script>`<br>`<link rel="stylesheet" href="https://cdn.jsdelivr.net/highlight.js/latest/styles/github.min.css">`
  - **hljs**: An injectible instance of
[highlight.js](https://github.com/isagalaev/highlight.js). If you don't want to
rely on the global namespace (`window.hljs`), you can provide an instance here.
Defaults to `undefined`.
  - **markedOptions**: Set the internal Markdown renderer's
  [options](https://github.com/chjj/marked#options-1). Other `renderingConfig`
  options will take precedence.
  - **singleLineBreaks**: If set to `false`, disable parsing GFM single line
  breaks. Defaults to `true`.
- **shortcuts**: Keyboard shortcuts associated with this instance. Defaults to
the [array of shortcuts](#keyboard-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 to `false`, disable the spell checker. Defaults to
`true`.
- **status**: If set to `false`, 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 to `false`, remove the `CodeMirror-selectedtext`
class from selected lines. Defaults to `true`.
- **syncSideBySidePreviewScroll**: If set to `false`, disable syncing scroll in
side by side mode. Defaults to `true`.
- **tabSize**: If set, customize the tab size. Defaults to `2`.
- **theme**: Override the theme. Defaults to `easymde`.
- **toolbar**: If set to `false`, hide the toolbar. Defaults to the
[array of icons](#toolbar-icons).
- **toolbarTips**: If set to `false`, disable toolbar button tips. Defaults to
`true`.


### Options example

Most options demonstrate the non-default behavior:

```JavaScript
var easyMDE = new EasyMDE({
	autofocus: true,
	autosave: {
		enabled: true,
		uniqueId: "MyUniqueID",
		delay: 1000,
	},
	blockStyles: {
		bold: "__",
		italic: "_"
	},
	element: document.getElementById("MyID"),
	forceSync: true,
	hideIcons: ["guide", "heading"],
	indentWithTabs: false,
	initialValue: "Hello world!",
	insertTexts: {
		horizontalRule: ["", "\n\n-----\n\n"],
		image: ["![](http://", ")"],
		link: ["[", "](http://)"],
		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...",
	previewRender: function(plainText) {
		return customMarkdownParser(plainText); // Returns HTML from a custom parser
	},
	previewRender: function(plainText, preview) { // Async method
		setTimeout(function(){
			preview.innerHTML = customMarkdownParser(plainText);
		}, 250);

		return "Loading...";
	},
	promptURLs: true,
	promptTexts: {
		image: "Custom prompt for URL:",
		link: "Custom prompt for URL:",
	},
	renderingConfig: {
		singleLineBreaks: false,
		codeSyntaxHighlighting: true,
	},
	shortcuts: {
		drawTable: "Cmd-Alt-T"
	},
	showIcons: ["code", "table"],
	spellChecker: false,
	status: false,
	status: ["autosave", "lines", "words", "cursor"], // Optional usage
	status: ["autosave", "lines", "words", "cursor", {
		className: "keystrokes",
		defaultValue: function(el) {
			this.keystrokes = 0;
			el.innerHTML = "0 Keystrokes";
		},
		onUpdate: function(el) {
			el.innerHTML = ++this.keystrokes + " Keystrokes";
		}
	}], // Another optional usage, with a custom status bar item that counts keystrokes
	styleSelectedText: false,
	syncSideBySidePreviewScroll: false,
	tabSize: 4,
	toolbar: false,
	toolbarTips: false,
});
```


### Toolbar icons

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 JS. "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 the
`title=""` 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 of `action` set to `bold` and that of `tooltip` set to `Bold`, 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.

Name | Action | Tooltip<br>Class
:--- | :----- | :--------------
bold | toggleBold | Bold<br>fa fa-bold
italic | toggleItalic | Italic<br>fa fa-italic
strikethrough | toggleStrikethrough | Strikethrough<br>fa fa-strikethrough
heading | toggleHeadingSmaller | Heading<br>fa fa-header
heading-smaller | toggleHeadingSmaller | Smaller Heading<br>fa fa-header
heading-bigger | toggleHeadingBigger | Bigger Heading<br>fa fa-lg fa-header
heading-1 | toggleHeading1 | Big Heading<br>fa fa-header header-1
heading-2 | toggleHeading2 | Medium Heading<br>fa fa-header header-2
heading-3 | toggleHeading3 | Small Heading<br>fa fa-header header-3
code | toggleCodeBlock | Code<br>fa fa-code
quote | toggleBlockquote | Quote<br>fa fa-quote-left
unordered-list | toggleUnorderedList | Generic List<br>fa fa-list-ul
ordered-list | toggleOrderedList | Numbered List<br>fa fa-list-ol
clean-block | cleanBlock | Clean block<br>fa fa-eraser
link | drawLink | Create Link<br>fa fa-link
image | drawImage | Insert Image<br>fa fa-picture-o
table | drawTable | Insert Table<br>fa fa-table
horizontal-rule | drawHorizontalRule | Insert Horizontal Line<br>fa fa-minus
preview | togglePreview | Toggle Preview<br>fa fa-eye no-disable
side-by-side | toggleSideBySide | Toggle Side by Side<br>fa fa-columns no-disable no-mobile
fullscreen | toggleFullScreen | Toggle Fullscreen<br>fa fa-arrows-alt no-disable no-mobile
guide | [This link](https://simplemde.com/markdown-guide) | Markdown Guide<br>fa fa-question-circle

### Toolbar customization

You can customize the toolbar using the `toolbar` option.

Only the order of existing buttons:

```JavaScript
var easyMDE = new EasyMDE({
	toolbar: ["bold", "italic", "heading", "|", "quote"],
});
```

Or all information and/or add your own icons:

```JavaScript
var easyMDE = new EasyMDE({
	toolbar: [{
			name: "bold",
			action: EasyMDE.toggleBold,
			className: "fa fa-bold",
			title: "Bold",
		},
		{
			name: "custom",
			action: function customFunction(editor){
				// Add your own code
			},
			className: "fa fa-star",
			title: "Custom Button",
		},
		"|", // Separator
		// ...
	],
});
```


### Keyboard shortcuts

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:

Shortcut (Windows / Linux) | Shortcut (macOS) | Action
:--- | :--- | :---
*Ctrl-'* | *Cmd-'* | "toggleBlockquote"
*Ctrl-B* | *Cmd-B* | "toggleBold"
*Ctrl-E* | *Cmd-E* | "cleanBlock"
*Ctrl-H* | *Cmd-H* | "toggleHeadingSmaller"
*Ctrl-I* | *Cmd-I* | "toggleItalic"
*Ctrl-K* | *Cmd-K* | "drawLink"
*Ctrl-L* | *Cmd-L* | "toggleUnorderedList"
*Ctrl-P* | *Cmd-P* | "togglePreview"
*Ctrl-Alt-C* | *Cmd-Alt-C* | "toggleCodeBlock"
*Ctrl-Alt-I* | *Cmd-Alt-I* | "drawImage"
*Ctrl-Alt-L* | *Cmd-Alt-L* | "toggleOrderedList"
*Shift-Ctrl-H* | *Shift-Cmd-H* | "toggleHeadingBigger"
*F9* | *F9* | "toggleSideBySide"
*F11* | *F11* | "toggleFullScreen"

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

```JavaScript
var easyMDE = new EasyMDE({
	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 for [toolbar buttons](#toolbar-icons).


## Advanced use

### Event handling

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

```JavaScript
var easyMDE = new EasyMDE();
easyMDE.codemirror.on("change", function(){
	console.log(easyMDE.value());
});
```

### Removing EasyMDE from text area

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

```JavaScript
var easyMDE = new EasyMDE();
// ...
easyMDE.toTextArea();
easyMDE = null;
```


### Useful methods

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

```js
var easyMDE = new EasyMDE();
easyMDE.isPreviewActive(); // returns boolean
easyMDE.isSideBySideActive(); // returns boolean
easyMDE.isFullscreenActive(); // returns boolean
easyMDE.clearAutosavedValue(); // no returned value
```


## How it works

EasyMDE began as an improvement of
[lepture's Editor project](https://github.com/lepture/editor), but has now taken
on an identity of its own. It is bundled with
[CodeMirror](https://github.com/codemirror/codemirror) and depends on
[Font Awesome](http://fontawesome.io).

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 by
[Marked](https://github.com/chjj/marked) using GFM.


## SimpleMDE fork

I originally made this fork to implement FontAwesome 5 compatibility into
EasyMDE. When that was done I submitted a
[pull request](https://github.com/sparksuite/simplemde-markdown-editor/pull/666),
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 now `https://` 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.

## License

This project is released under the [MIT License](./LICENSE).

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