PLUGIN Markdown

[github/shaarli/Shaarli.git] / plugins / markdown / README.md

diff --git a/plugins/markdown/README.md b/plugins/markdown/README.md
new file mode 100644 (file)
index 0000000..22d0af3
--- /dev/null
+++ b/plugins/markdown/README.md
@@ -0,0 +1,51 @@
+## Markdown Shaarli plugin\r
+\r
+Convert all your shaares description to HTML formatted Markdown.\r
+\r
+Read more about Markdown syntax here.\r
+\r
+### Installation\r
+\r
+Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there.\r
+The directory structure should look like:\r
+\r
+```\r
+??? plugins\r
+    ??? markdown\r
+        ??? help.html\r
+        ??? markdown.css\r
+        ??? markdown.meta\r
+        ??? markdown.php\r
+        ??? Parsedown.php\r
+        ??? README.md\r
+```\r
+\r
+To enable the plugin, add `markdown` to your list of enabled plugins in `data/config.php`\r
+(`ENABLED_PLUGINS` array).\r
+\r
+This should look like:\r
+\r
+```\r
+$GLOBALS['config']['ENABLED_PLUGINS'] = array('qrcode', 'any_other_plugin', 'markdown')\r
+```\r
+\r
+### Known issue\r
+\r
+#### Redirector\r
+\r
+If you're using a redirector, you *need* to add a space after a link,\r
+otherwise the rest of the line will be `urlencode`.\r
+\r
+```\r
+[link](http://domain.tld)-->test\r
+```\r
+\r
+Will consider `http://domain.tld)-->test` as URL.\r
+\r
+Instead, add an additional space.\r
+\r
+```\r
+[link](http://domain.tld) -->test\r
+```\r
+\r
+> Won't fix because a `)` is a valid part of an URL.\r