Netsyms/easy-markdown-editor
2
0
Fork 0
mirror of https://github.com/Ionaru/easy-markdown-editor synced 2025-09-14 11:42:35 -06:00
Code Issues Releases Wiki Activity

Update readme with overlayMode options.

Browse Source
This commit is contained in:
czynskee 2020-09-16 12:48:52 -07:00
parent 4ce74e904b
commit eac3f519fb
1 changed files with 24 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -23,25 +23,27 @@ The editor is entirely customizable, from theming to toolbar buttons and javascr
## Quick access ## Quick access
- [Install EasyMDE](#install-easymde) - [EasyMDE - Markdown Editor](#easymde---markdown-editor)
- [How to use](#how-to-use) - [Quick access](#quick-access)
- [Loading the editor](#loading-the-editor) - [Install EasyMDE](#install-easymde)
- [Editor functions](#editor-functions) - [How to use](#how-to-use)
- [Configuration](#configuration) - [Loading the editor](#loading-the-editor)
- [Options list](#options-list) - [Editor functions](#editor-functions)
- [Options example](#options-example) - [Configuration](#configuration)
- [Toolbar icons](#toolbar-icons) - [Options list](#options-list)
- [Toolbar customization](#toolbar-customization) - [Options example](#options-example)
- [Keyboard shortcuts](#keyboard-shortcuts) - [Toolbar icons](#toolbar-icons)
- [Advanced use](#advanced-use) - [Toolbar customization](#toolbar-customization)
- [Event handling](#event-handling) - [Keyboard shortcuts](#keyboard-shortcuts)
- [Removing EasyMDE from text area](#removing-easymde-from-text-area) - [Advanced use](#advanced-use)
- [Useful methods](#useful-methods) - [Event handling](#event-handling)
- [How it works](#how-it-works) - [Removing EasyMDE from text area](#removing-easymde-from-text-area)
- [SimpleMDE fork](#simplemde-fork) - [Useful methods](#useful-methods)
- [Hacking EasyMDE](#hacking-easymde) - [How it works](#how-it-works)
- [Contributing](#contributing) - [SimpleMDE fork](#simplemde-fork)
- [License](#license) - [Hacking EasyMDE](#hacking-easymde)
- [Contributing](#contributing)
- [License](#license)
## Install EasyMDE ## Install EasyMDE
@ -147,6 +149,9 @@ easyMDE.value('New input for **EasyMDE**');
- **allowAtxHeaderWithoutSpace**: If set to `true`, will render headers without a space after the `#`. Defaults to `false`. - **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`. - **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`. - **underscoresBreakWords**: If set to `true`, let underscores be a delimiter for separating words. Defaults to `false`.
- **overlayMode**: Pass a custom codemirror [overlay mode](https://codemirror.net/doc/manual.html#modeapi) to parse and style the Markdown during editing.
- **mode**: A codemirror mode object.
- **combine**: If set to `false`, will *replace* 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 to `true`.
- **placeholder**: If set, displays a custom placeholder message. - **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"`. - **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. - **previewRender**: Custom function for parsing the plaintext Markdown and returning HTML. Used when user previews.