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 4f021871e47d6827118b223cdffd2902e819f3b5..c64a831a1cb2a76f1a724889fe8fe900c0c34a94 100644 (file)
--- a/plugins/markdown/README.md
+++ b/plugins/markdown/README.md
@@ -41,6 +41,23 @@ If the tag `.nomarkdown` is set for a shaare, it won't be converted to Markdown
  
 > 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