diff options
Diffstat (limited to 'plugins/markdown/README.md')
-rw-r--r-- | plugins/markdown/README.md | 102 |
1 files changed, 51 insertions, 51 deletions
diff --git a/plugins/markdown/README.md b/plugins/markdown/README.md index 22d0af35..defaacd1 100644 --- a/plugins/markdown/README.md +++ b/plugins/markdown/README.md | |||
@@ -1,51 +1,51 @@ | |||
1 | ## Markdown Shaarli plugin | 1 | ## Markdown Shaarli plugin |
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 here. |
6 | 6 | ||
7 | ### Installation | 7 | ### Installation |
8 | 8 | ||
9 | Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there. | 9 | Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there. |
10 | The directory structure should look like: | 10 | The directory structure should look like: |
11 | 11 | ||
12 | ``` | 12 | ``` |
13 | ??? plugins | 13 | ??? plugins |
14 | ??? markdown | 14 | ??? markdown |
15 | ??? help.html | 15 | ??? help.html |
16 | ??? markdown.css | 16 | ??? markdown.css |
17 | ??? markdown.meta | 17 | ??? markdown.meta |
18 | ??? markdown.php | 18 | ??? markdown.php |
19 | ??? Parsedown.php | 19 | ??? Parsedown.php |
20 | ??? README.md | 20 | ??? README.md |
21 | ``` | 21 | ``` |
22 | 22 | ||
23 | To enable the plugin, add `markdown` to your list of enabled plugins in `data/config.php` | 23 | To enable the plugin, add `markdown` to your list of enabled plugins in `data/config.php` |
24 | (`ENABLED_PLUGINS` array). | 24 | (`ENABLED_PLUGINS` array). |
25 | 25 | ||
26 | This should look like: | 26 | This should look like: |
27 | 27 | ||
28 | ``` | 28 | ``` |
29 | $GLOBALS['config']['ENABLED_PLUGINS'] = array('qrcode', 'any_other_plugin', 'markdown') | 29 | $GLOBALS['config']['ENABLED_PLUGINS'] = array('qrcode', 'any_other_plugin', 'markdown') |
30 | ``` | 30 | ``` |
31 | 31 | ||
32 | ### Known issue | 32 | ### Known issue |
33 | 33 | ||
34 | #### Redirector | 34 | #### Redirector |
35 | 35 | ||
36 | If you're using a redirector, you *need* to add a space after a link, | 36 | If you're using a redirector, you *need* to add a space after a link, |
37 | otherwise the rest of the line will be `urlencode`. | 37 | otherwise the rest of the line will be `urlencode`. |
38 | 38 | ||
39 | ``` | 39 | ``` |
40 | [link](http://domain.tld)-->test | 40 | [link](http://domain.tld)-->test |
41 | ``` | 41 | ``` |
42 | 42 | ||
43 | Will consider `http://domain.tld)-->test` as URL. | 43 | Will consider `http://domain.tld)-->test` as URL. |
44 | 44 | ||
45 | Instead, add an additional space. | 45 | Instead, add an additional space. |
46 | 46 | ||
47 | ``` | 47 | ``` |
48 | [link](http://domain.tld) -->test | 48 | [link](http://domain.tld) -->test |
49 | ``` | 49 | ``` |
50 | 50 | ||
51 | > Won't fix because a `)` is a valid part of an URL. | 51 | > Won't fix because a `)` is a valid part of an URL. |