A plugin that will finally allow you to ditch the markdown viewer, saving space and making your life easier.
npm install joplin-plugin-rich-markdownA plugin that will finally allow you to ditch the markdown viewer, saving space and making your life easier.
Rich Markdown comes as a collection of multiple features that can be toggled in settings. The main goal is to add better interaction features to the editor, namely image viewing, checkbox interaction, and links. It also adds a number of CSS classes that make it possible to add extra customization to the markdown editor. Checkout the image below to see how far this can go!
The above theme can be applied in the plugin settings menu (this one is called "Stylish"). Thanks to @uxamanda for the awesome theme!
Tools -> Options -> Rich Markdown -> Add additional CSS classes for enhanced customization.This is enabled by default.
Example of an image on hover
This is not enabled by default, but can be quick toggled in the View menu.
Example of images being rendered in markdown editor
This is enabled by default.
This is enabled by default.
Insert syntax (++insert++), sub (~sub~), and sup (^sup^) syntaxes are also available and enabled in the same way.
This can be enabled under Tools -> Options -> Markdown -> Enable ==mark== syntax.
This is enabled by default.
.cm-header.cm-rm-header-token: The grouping of hashtags (#) at the start of a header
.cm-em.cm-rm-em-token: The \* or \_ used to begin italics
.cm-strong.cm-rm-strong-token: The \\ or \_\_ used to begin bold
.cm-rm-highlight: The highlighted text (including the ==)
.cm-rm-highlight.cm-rm-highlight-token: The == used to begin highlighting
.cm-strikethrough.cm-rm-strike-token: The \~\~ used to begin a strike through
.cm-rm-ins.cm-rm-ins-token: The ++ used to begin the insert syntax
.cm-rm-sub.cm-rm-sub-token: The ~ used to begin the sub syntax
.cm-rm-sup.cm-rm-sup-token: The ^ used to begin the sup syntax
pre.cm-rm-hr.CodeMirror-line: Used to support drawing a horizontal rule see here
pre.cm-rm-blockquote.CodeMirror-line: The line that contains a block quote
If you have a suggestion for something you'd like to be able to customize. Just let me know and I'll see whats possible.
This is disabled by default.
- Go to Tools -> Options -> Plugins(macOS: Joplin -> Preferences -> Plugins)
- Search for "Rich Markdown" in the search box
- Click Install and restart Joplin
#### Or
- Download the plugin jpl
- Go to Tools -> Options -> Plugins
- Click on the gear icon and select "Install from file"
- Select the downloaded jpl file
- Restart Joplin
The aim of this project is to ditch the markdown viewer without trying to turn a markdown document into some kind of unholy WYSIAWYG (what you see is almost what you get). To that end, feature requests that hide markdown or otherwise introduce invisible formatting will be treated skeptically. The intention of this project is not to build the worlds best (most performant, beautiful, etc.) markdown editor, but rather to build something that can make my (and others!) life a little bit nicer.
Please make feature requests (please prepend the title with Feature Request) on the github page, or on the rich markdown forum topic.
Go to Tips to see a collection of CSS styling tips to get the most out of the Rich Markdown plugin.
!joplin
is cool
``