From 4eec6e6e3a55ab755c1baf5fe7f556b6bff9b8f5 Mon Sep 17 00:00:00 2001 From: Wes Cossick Date: Sat, 5 Dec 2015 00:37:12 -0600 Subject: [PATCH] Document showIcons; Tweak other wording --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 14f97a6..bc6c1ef 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ simplemde.value("This text will appear in the editor"); - **bold** Can be set to `**` or `__`. Defaults to `**`. - **italic** Can be set to `*` or `_`. Defaults to `*`. - **element**: The DOM element for the textarea to use. Defaults to the first textarea on the page. -- **hideIcons**: An array of icon names to hide. Can be used to hide specific icons without completely customizing the toolbar. +- **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://)"]`. @@ -94,6 +94,7 @@ simplemde.value("This text will appear in the editor"); - **renderingConfig**: Adjust settings for parsing the Markdown during previewing (not editing). - **singleLineBreaks**: If set to `false`, disable parsing GFM single line breaks. Defaults to `true`. - **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. For example, include the script and the CSS files like:
``
`` +- **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 `true`. - Optionally, you can set an array of status bar elements to include, and in what order. @@ -144,6 +145,7 @@ var simplemde = new SimpleMDE({ singleLineBreaks: false, codeSyntaxHighlighting: true, }, + showIcons: ["code", "table"], spellChecker: false, status: false, status: ["autosave", "lines", "words", "cursor"], // Optional usage @@ -174,8 +176,8 @@ unordered-list | toggleUnorderedList | Generic List (Ctrl+L)
fa fa-list-ul ordered-list | toggleOrderedList | Numbered List (Ctrl+Alt+L)
fa fa-list-ol link | drawLink | Create Link (Ctrl+K)
fa fa-link image | drawImage | Insert Image (Ctrl+Alt+I)
fa fa-picture-o -horizontal-rule | drawHorizontalRule | Insert Horizontal Line
fa fa-minus table | drawTable | Insert Table
fa fa-table +horizontal-rule | drawHorizontalRule | Insert Horizontal Line
fa fa-minus preview | togglePreview | Toggle Preview (Ctrl+P)
fa fa-eye no-disable side-by-side | toggleSideBySide | Toggle Side by Side (F9)
fa fa-columns no-disable no-mobile fullscreen | toggleFullScreen | Toggle Fullscreen (F11)
fa fa-arrows-alt no-disable no-mobile