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