Merge pull request #701 from ArthurHoaro/plugins/md-html-doc

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

diff --git a/plugins/markdown/README.md b/plugins/markdown/README.md
index 22d0af356b92daa493aaa9abd60acaa880b0088f..aafcf0662ecf778da3051a44f891f5add70d3479 100644 (file)
--- a/plugins/markdown/README.md
+++ b/plugins/markdown/README.md
@@ -1,51 +1,89 @@
-## 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
+## Markdown Shaarli plugin
+
+Convert all your shaares description to HTML formatted Markdown.
+
+[Read more about Markdown syntax](http://daringfireball.net/projects/markdown/syntax).
+
+Markdown processing is done with [Parsedown library](https://github.com/erusev/parsedown).
+
+### Installation
+
+As a default plugin, it should already be in `tpl/plugins/` directory.
+If not, download and unpack it there.
+
+The directory structure should look like:
+
+```
+--- plugins
+  |--- markdown
+     |--- help.html
+     |--- markdown.css
+     |--- markdown.meta
+     |--- markdown.php
+     |--- README.md
+```
+
+To enable the plugin, just check it in the plugin administration page.
+
+You can also add `markdown` to your list of enabled plugins in `data/config.json.php`
+(`general.enabled_plugins` list).
+
+This should look like:
+
+```
+"general": {
+  "enabled_plugins": [
+    "markdown",
+    [...]
+  ],
+}
+```
+
+Parsedown parsing library is imported using Composer. If you installed Shaarli using `git`,
+or the `master` branch, run
+
+    composer update --no-dev --prefer-dist
+
+### No Markdown tag
+
+If the tag `nomarkdown` is set for a shaare, it won't be converted to Markdown syntax.
+ 
+> Note: this is a special tag, so it won't be displayed in link list.
+
+### HTML rendering
+
+Markdown support HTML tags. For example:
+
+    > <strong>strong</strong><strike>strike</strike>
+   
+Will render as:
+
+> <strong>strong</strong><strike>strike</strike>
+
+If you want to shaare HTML code, it is necessary to use inline code or code blocks.
+  
+**If your shaared descriptions containing HTML tags before enabling the markdown plugin, 
+enabling it might break your page.**
+
+> Note: HTML tags such as script, iframe, etc. are disabled for security reasons.
+
+### Known issue
+
+#### Redirector
+
+If you're using a redirector, you *need* to add a space after a link,
+otherwise the rest of the line will be `urlencode`.
+
+```
+[link](http://domain.tld)-->test
+```
+
+Will consider `http://domain.tld)-->test` as URL.
+
+Instead, add an additional space.
+
+```
+[link](http://domain.tld) -->test
+```
+
+> Won't fix because a `)` is a valid part of an URL.