Describe markdown HTML rendering and display a warning

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

diff --git a/plugins/markdown/README.md b/plugins/markdown/README.md
index defaacd1df567d7ad6ce6d327b0bac1cbc0597e9..c64a831a1cb2a76f1a724889fe8fe900c0c34a94 100644 (file)
--- a/plugins/markdown/README.md
+++ b/plugins/markdown/README.md
@@ -2,25 +2,31 @@
 
 Convert all your shaares description to HTML formatted Markdown.
 
-Read more about Markdown syntax here.
+[Read more about Markdown syntax](http://daringfireball.net/projects/markdown/syntax).
+
+Markdown processing is done with [Parsedown library](https://github.com/erusev/parsedown).
 
 ### Installation
 
-Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there.
+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
-        ??? Parsedown.php
-        ??? README.md
+--- plugins
+  |--- markdown
+     |--- help.html
+     |--- markdown.css
+     |--- markdown.meta
+     |--- markdown.php
+     |--- Parsedown.php
+     |--- README.md
 ```
 
-To enable the plugin, add `markdown` to your list of enabled plugins in `data/config.php`
+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.php`
 (`ENABLED_PLUGINS` array).
 
 This should look like:
@@ -29,6 +35,29 @@ This should look like:
 $GLOBALS['config']['ENABLED_PLUGINS'] = array('qrcode', 'any_other_plugin', 'markdown')
 ```
 
+### No Markdown tag
+
+If the tag `.nomarkdown` is set for a shaare, it won't be converted to Markdown syntax.
+ 
+> Note: it's a private tag (leading dot), so it won't be displayed to visitors.
+
+### 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