A clear and simple markdown editor.
Features
- GitHub flavoured markdown (GFM)
- Toggleable live preview
- With emoji support
Roadmap
This is a well working beta version. In fact if you only want an editor for markdown that works out of the box BlankUp is already perfect for you. Though there are great things coming. Since we are build on markdown-it we will enable you to use any of it's plugins. We also want to create an easy API (or something) to style the editor.
API
Objects
-
BlankUp :
object
Functions
-
BlankUp(container) ⇒
BlankUp -
Create an instance of a BlankUp Markdown editor in a given element.
BlankUp : object
Kind: global namespace
-
BlankUp :
object
blankUp.previewVisible(visible)
Set the visiblity of the preview.
Kind: instance method of BlankUp
| Param | Type | Description |
|---|---|---|
| visible | Boolean |
If the preview should be visible or not. |
blankUp.setMarkdown(markdown)
Set the current conent of the editor to a given markdown.
Kind: instance method of BlankUp
| Param | Type | Description |
|---|---|---|
| markdown | String |
New content of the editor. |
blankUp.on(event, listener)
Subscribe a listener to an event.
Kind: instance method of BlankUp
| Param | Type | Description |
|---|---|---|
| event | String |
The event to subscribe to. |
| listener | function |
Function to call when event happens. |
blankUp.getMarkdown() ⇒ String
Get the current content of the editor.
Kind: instance method of BlankUp
Returns: String - - The current markdown content of the editor.
blankUp.focus()
Focus the editor.
Kind: instance method of BlankUp
BlankUp(container) ⇒ BlankUp
Create an instance of a BlankUp Markdown editor in a given element.
Kind: global function
Returns: BlankUp - - An instance of a BlankUp editor.
| Param | Type | Description |
|---|---|---|
| container | DOMElement |
The Element of the DOM in which to create a BlankUp editor. |
Credits
Build on and using:
Huge props to markdown-editor where the basics of this came from. After that it really is mainly sugar.