X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=plugins%2Fmarkdown%2FREADME.md;h=c64a831a1cb2a76f1a724889fe8fe900c0c34a94;hb=3d8f5cf84b8baa4a212f5089633af7c640609b62;hp=4f021871e47d6827118b223cdffd2902e819f3b5;hpb=76fb679e38c6237fc2e39c12b829068c374b8372;p=github%2Fshaarli%2FShaarli.git
diff --git a/plugins/markdown/README.md b/plugins/markdown/README.md
index 4f021871..c64a831a 100644
--- 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:
+
+ > strongstrike
+
+Will render as:
+
+> strongstrike
+
+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