From 8ee0d8a73e31aa97d1189aa4054f83c62812bfba Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Tue, 11 Feb 2020 00:05:43 +0000 Subject: [PATCH] Doc: More info about Markdown plugins and standards --- readme/markdown.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/readme/markdown.md b/readme/markdown.md index dee490d118..86e7dc7b92 100644 --- a/readme/markdown.md +++ b/readme/markdown.md @@ -4,6 +4,8 @@ Markdown is a simple way to format text that looks great on any device. It doesn Joplin desktop and mobile applications can display both the Markdown text and the rendered rich text document. +Joplin follows the [CommonMark](https://spec.commonmark.org/) specification, with additional features added via plugins. + ## Cheat Sheet This is a quick summary of the Markdown syntax. @@ -116,6 +118,8 @@ It is generally recommended to enter the notes as Markdown as it makes the notes Joplin supports a number of plugins that can be toggled on top the standard Markdown features you would expect. These toggle-able plugins are listed below. Note: not all of the plugins are enabled by default, if the enable field is 'no' below, then open the option screen to enable the plugin. Plugins can be disabled in the same manner. +Note that the functionalities added by these plugins are not part of the CommonMark spec, so while they will all with in Joplin it is not guaranteed that they will work on other Markdown readers. Often this is not an issue but keep it in mind if you require compatibility with other Markdown applications. + | Plugin | Syntax | Description | Enabled | |--------|--------|-------------|---------| | Soft breaks | See [breaks](https://markdown-it.github.io/#md3=%7B%22source%22%3A%22This%20is%20line1%5CnThis%20is%20line2%5Cn%5CnThis%20is%20a%20line%20with%202%20trailing%20spaces%20%20%5CnNext%20line%5Cn%5CnClick%20the%20%60breaks%60%20checkbox%20above%20to%20see%20the%20difference.%5CnJoplin%27s%20default%20is%20hard%20breaks%20%28checked%20%60breaks%60%20checkbox%29.%22%2C%22defaults%22%3A%7B%22html%22%3Afalse%2C%22xhtmlOut%22%3Afalse%2C%22breaks%22%3Afalse%2C%22langPrefix%22%3A%22language-%22%2C%22linkify%22%3Afalse%2C%22typographer%22%3Afalse%2C%22_highlight%22%3Afalse%2C%22_strict%22%3Afalse%2C%22_view%22%3A%22html%22%7D%7D) markdown-it demo| Joplin uses hard breaks by default, which means that a line break is rendered as `
`. Enable soft breaks for traditional markdown line-break behaviour. | no |