aboutsummaryrefslogtreecommitdiffhomepage
path: root/plugins/markdown/README.md
diff options
context:
space:
mode:
authorArthur <arthur@hoa.ro>2016-03-26 16:46:04 +0100
committerArthur <arthur@hoa.ro>2016-03-26 16:46:04 +0100
commit1a84bf1e2bc45787d9cfa81fa427a11a3aba623a (patch)
treef9b72b6048b2ba2ab9e6a972a0a238e49e2882f1 /plugins/markdown/README.md
parentf66a1990e5d93a6f302ce594968e5e717b93da72 (diff)
parent340252ae5de67f46ad43793858532da0cce8b4e2 (diff)
downloadShaarli-1a84bf1e2bc45787d9cfa81fa427a11a3aba623a.tar.gz
Shaarli-1a84bf1e2bc45787d9cfa81fa427a11a3aba623a.tar.zst
Shaarli-1a84bf1e2bc45787d9cfa81fa427a11a3aba623a.zip
Merge pull request #520 from ArthurHoaro/plugins/nomarkdown
Markdown: Add the 'meta-tag' `.nomarkdown` which prevent a shaare fro…
Diffstat (limited to 'plugins/markdown/README.md')
-rw-r--r--plugins/markdown/README.md34
1 files changed, 23 insertions, 11 deletions
diff --git a/plugins/markdown/README.md b/plugins/markdown/README.md
index defaacd1..4f021871 100644
--- a/plugins/markdown/README.md
+++ b/plugins/markdown/README.md
@@ -2,25 +2,31 @@
2 2
3Convert all your shaares description to HTML formatted Markdown. 3Convert all your shaares description to HTML formatted Markdown.
4 4
5Read more about Markdown syntax here. 5[Read more about Markdown syntax](http://daringfireball.net/projects/markdown/syntax).
6
7Markdown processing is done with [Parsedown library](https://github.com/erusev/parsedown).
6 8
7### Installation 9### Installation
8 10
9Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there. 11As a default plugin, it should already be in `tpl/plugins/` directory.
12If not, download and unpack it there.
13
10The directory structure should look like: 14The directory structure should look like:
11 15
12``` 16```
13??? plugins 17--- plugins
14    ??? markdown 18 |--- markdown
15 ??? help.html 19 |--- help.html
16 ??? markdown.css 20 |--- markdown.css
17 ??? markdown.meta 21 |--- markdown.meta
18 ??? markdown.php 22 |--- markdown.php
19 ??? Parsedown.php 23 |--- Parsedown.php
20    ??? README.md 24 |--- README.md
21``` 25```
22 26
23To enable the plugin, add `markdown` to your list of enabled plugins in `data/config.php` 27To enable the plugin, just check it in the plugin administration page.
28
29You can also add `markdown` to your list of enabled plugins in `data/config.php`
24(`ENABLED_PLUGINS` array). 30(`ENABLED_PLUGINS` array).
25 31
26This should look like: 32This should look like:
@@ -29,6 +35,12 @@ This should look like:
29$GLOBALS['config']['ENABLED_PLUGINS'] = array('qrcode', 'any_other_plugin', 'markdown') 35$GLOBALS['config']['ENABLED_PLUGINS'] = array('qrcode', 'any_other_plugin', 'markdown')
30``` 36```
31 37
38### No Markdown tag
39
40If the tag `.nomarkdown` is set for a shaare, it won't be converted to Markdown syntax.
41
42> Note: it's a private tag (leading dot), so it won't be displayed to visitors.
43
32### Known issue 44### Known issue
33 45
34#### Redirector 46#### Redirector