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:
27 To enable the plugin, just check it in the plugin administration page.
29 You can also add `markdown` to your list of enabled plugins in `data/config.php`
30 (`ENABLED_PLUGINS` array).
32 This should look like:
35 $GLOBALS['config']['ENABLED_PLUGINS'] = array('qrcode', 'any_other_plugin', 'markdown')
40 If the tag `.nomarkdown` is set for a shaare, it won't be converted to Markdown syntax.
42 > Note: it's a private tag (leading dot), so it won't be displayed to visitors.
46 Markdown support HTML tags. For example:
48 > <strong>strong</strong><strike>strike</strike>
52 > <strong>strong</strong><strike>strike</strike>
54 If you want to shaare HTML code, it is necessary to use inline code or code blocks.
56 **If your shaared descriptions containing HTML tags before enabling the markdown plugin,
57 enabling it might break your page.**
59 > Note: HTML tags such as script, iframe, etc. are disabled for security reasons.
65 If you're using a redirector, you *need* to add a space after a link,
66 otherwise the rest of the line will be `urlencode`.
69 [link](http://domain.tld)-->test
72 Will consider `http://domain.tld)-->test` as URL.
74 Instead, add an additional space.
77 [link](http://domain.tld) -->test
80 > Won't fix because a `)` is a valid part of an URL.