diff options
author | ArthurHoaro <arthur@hoa.ro> | 2016-03-26 16:43:14 +0100 |
---|---|---|
committer | ArthurHoaro <arthur@hoa.ro> | 2016-03-26 16:43:14 +0100 |
commit | 340252ae5de67f46ad43793858532da0cce8b4e2 (patch) | |
tree | e2b0f17af159ed18112472cb3b6ebbb7ee7976ae | |
parent | 3ce20d9e84a715c6890988999a8ecac210a42d9c (diff) | |
download | Shaarli-340252ae5de67f46ad43793858532da0cce8b4e2.tar.gz Shaarli-340252ae5de67f46ad43793858532da0cce8b4e2.tar.zst Shaarli-340252ae5de67f46ad43793858532da0cce8b4e2.zip |
Update markdown plugin README documentation
* Add the `.nomarkdown` section.
* Update misleading statements.
-rw-r--r-- | plugins/markdown/README.md | 34 |
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 | ||
3 | Convert all your shaares description to HTML formatted Markdown. | 3 | Convert all your shaares description to HTML formatted Markdown. |
4 | 4 | ||
5 | Read more about Markdown syntax here. | 5 | [Read more about Markdown syntax](http://daringfireball.net/projects/markdown/syntax). |
6 | |||
7 | Markdown processing is done with [Parsedown library](https://github.com/erusev/parsedown). | ||
6 | 8 | ||
7 | ### Installation | 9 | ### Installation |
8 | 10 | ||
9 | Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there. | 11 | As a default plugin, it should already be in `tpl/plugins/` directory. |
12 | If not, download and unpack it there. | ||
13 | |||
10 | The directory structure should look like: | 14 | The 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 | ||
23 | To enable the plugin, add `markdown` to your list of enabled plugins in `data/config.php` | 27 | To enable the plugin, just check it in the plugin administration page. |
28 | |||
29 | You can also add `markdown` to your list of enabled plugins in `data/config.php` | ||
24 | (`ENABLED_PLUGINS` array). | 30 | (`ENABLED_PLUGINS` array). |
25 | 31 | ||
26 | This should look like: | 32 | This 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 | |||
40 | If 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 |