]>
Commit | Line | Data |
---|---|---|
14563582 A |
1 | ## Markdown Shaarli plugin |
2 | ||
3 | Convert all your shaares description to HTML formatted Markdown. | |
4 | ||
340252ae A |
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). | |
14563582 A |
8 | |
9 | ### Installation | |
10 | ||
340252ae A |
11 | As a default plugin, it should already be in `tpl/plugins/` directory. |
12 | If not, download and unpack it there. | |
13 | ||
14563582 A |
14 | The directory structure should look like: |
15 | ||
16 | ``` | |
340252ae A |
17 | --- plugins |
18 | |--- markdown | |
19 | |--- help.html | |
20 | |--- markdown.css | |
21 | |--- markdown.meta | |
22 | |--- markdown.php | |
340252ae | 23 | |--- README.md |
14563582 A |
24 | ``` |
25 | ||
340252ae A |
26 | To enable the plugin, just check it in the plugin administration page. |
27 | ||
266e3fe5 A |
28 | You can also add `markdown` to your list of enabled plugins in `data/config.json.php` |
29 | (`general.enabled_plugins` list). | |
14563582 A |
30 | |
31 | This should look like: | |
32 | ||
33 | ``` | |
266e3fe5 A |
34 | "general": { |
35 | "enabled_plugins": [ | |
36 | "markdown", | |
37 | [...] | |
38 | ], | |
39 | } | |
14563582 A |
40 | ``` |
41 | ||
266e3fe5 A |
42 | Parsedown parsing library is imported using Composer. If you installed Shaarli using `git`, |
43 | or the `master` branch, run | |
44 | ||
45 | composer update --no-dev --prefer-dist | |
46 | ||
340252ae A |
47 | ### No Markdown tag |
48 | ||
266e3fe5 | 49 | If the tag `nomarkdown` is set for a shaare, it won't be converted to Markdown syntax. |
340252ae | 50 | |
266e3fe5 | 51 | > Note: this is a special tag, so it won't be displayed in link list. |
340252ae | 52 | |
14563582 A |
53 | ### Known issue |
54 | ||
55 | #### Redirector | |
56 | ||
57 | If you're using a redirector, you *need* to add a space after a link, | |
58 | otherwise the rest of the line will be `urlencode`. | |
59 | ||
60 | ``` | |
61 | [link](http://domain.tld)-->test | |
62 | ``` | |
63 | ||
64 | Will consider `http://domain.tld)-->test` as URL. | |
65 | ||
66 | Instead, add an additional space. | |
67 | ||
68 | ``` | |
69 | [link](http://domain.tld) -->test | |
70 | ``` | |
71 | ||
72 | > Won't fix because a `)` is a valid part of an URL. |