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