

Enable soft breaks for traditional markdown line-break behaviour.ĭoes typographic replacements, (c) -> © and so onĪuto-detects URLs and convert them to clickable linksĪdds support for the Fountain markup language, a plain text markup language for screenwritingĪdds a table of contents to the location of the toc page. Joplin uses hard breaks by default, which means that a line break is rendered as. Often this is not an issue but keep it in mind if you require compatibility with other Markdown applications. The functionality added by these plugins is not part of the CommonMark spec so, while they will all work within Joplin, it is not guaranteed that they will work in other Markdown readers. Plugins can be disabled in the same manner. Not all of the plugins are enabled by default, if the "enabled" field is 'no' below, then open the option screen to enable the plugin. Unlike regular plugins, Markdown plugins must be enabled in the markdown section of the Configuration screen. Joplin supports a number of plugins that can be toggled on/off to enable/disable markdown features on top of the standard Markdown features you would expect. For example this would be a valid note: This is strikethrough text mixed with regular **Markdown**.
Markdown formatting code#
However for cases where certain features aren't supported (such as strikethrough or to highlight text), you can also use HTML code directly. It is generally recommended to enter the notes as Markdown as it makes the notes easier to edit. The checkboxes can then be ticked in the mobile and desktop applications. Checkboxes 🔗Ĭheckboxes can be added like so: - Milk This is because they can contain various colours that may not be compatible with the current theme. Note that Mermaid graphs are always rendered on a white background regardless of the current theme. This is how it would look with the Markdown on the left, and rendered graph on the right: To add such a graph, wrap the Mermaid script inside a "```mermaid" code block like this: ```mermaid You can create diagrams in Joplin using the Mermaid syntax. See the mhchem documentation for the syntax. This plugin is automatically enabled if you enable math notation. Joplin supports chemical equations via the mhchem plugin for KaTeX. Here is an example with the Markdown and rendered result side by side: Chemical equations 🔗 To create an expression block, wrap it as follow: $$ To add an inline equation, wrap the expression in $EXPRESSION$, eg. Math expressions can be added using the KaTeX notation.


You can then paste this link anywhere in another note. In the mobile app, open a note and, in the top right menu, select "Copy Markdown link". Or right click on a note and select "Copy Markdown link". In the desktop app, drag and drop a note into another note to create a link. Since getting the ID of a note is not straightforward, each app provides a way to create such link. You can create a link to a note by specifying its ID in the URL. | - |:-:| -:|īesides the standard Markdown syntax, Joplin supports several additional features. Note that there must be at least 3 dashes separating each header cell.Ĭolons can be used to align columns: | Tables | Are | Cool | This is a Markdown table: | First Header | Second Header | Tables are created using pipes | and hyphens. Indent with a tab or 4 spaces for unformatted text.Īnd this is a link anchoring text content: Language is normally auto-detected, but it can also be specified:įor unformatted text. * Milk * Eggs * Beers * Desperados * Heineken * Hamġ. This is a quick summary of the Markdown syntax. Joplin follows the CommonMark specification, with additional features added via plugins. Joplin desktop and mobile applications can display both the Markdown text and the rendered rich text document. Since it is plain text, it is an easy way to author notes and documents and when needed it can be converted to a rich text HTML document. It doesn't do anything fancy like change the font size, color, or type - just the essentials, using keyboard symbols you already know. Markdown is a simple way to format text that looks great on any device.
