1 ## Markdown Shaarli plugin
3 Convert all your shaares description to HTML formatted Markdown.
5 [Read more about Markdown syntax](http://daringfireball.net/projects/markdown/syntax).
7 Markdown processing is done with [Parsedown library](https://github.com/erusev/parsedown).
11 As a default plugin, it should already be in `tpl/plugins/` directory.
12 If not, download and unpack it there.
14 The directory structure should look like:
26 To enable the plugin, just check it in the plugin administration page.
28 You can also add `markdown` to your list of enabled plugins in `data/config.json.php`
29 (`general.enabled_plugins` list).
31 This should look like:
42 Parsedown parsing library is imported using Composer. If you installed Shaarli using `git`,
43 or the `master` branch, run
45 composer update --no-dev --prefer-dist
49 If the tag `nomarkdown` is set for a shaare, it won't be converted to Markdown syntax.
51 > Note: this is a special tag, so it won't be displayed in link list.
55 By default, HTML tags are escaped. You can enable HTML tags rendering
56 by setting `security.markdwon_escape` to `false` in `data/config.json.php`:
61 "markdown_escape": false
66 With this setting, Markdown support HTML tags. For example:
68 > <strong>strong</strong><strike>strike</strike>
72 > <strong>strong</strong><strike>strike</strike>
77 * This setting might present **security risks** (XSS) on shared instances, even though tags
78 such as script, iframe, etc should be disabled.
79 * If you want to shaare HTML code, it is necessary to use inline code or code blocks.
80 * If your shaared descriptions contained HTML tags before enabling the markdown plugin,
81 enabling it might break your page.
87 If you're using a redirector, you *need* to add a space after a link,
88 otherwise the rest of the line will be `urlencode`.
91 [link](http://domain.tld)-->test
94 Will consider `http://domain.tld)-->test` as URL.
96 Instead, add an additional space.
99 [link](http://domain.tld) -->test
102 > Won't fix because a `)` is a valid part of an URL.