X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=plugins%2Fmarkdown%2FREADME.md;h=bc9427e23600a6f624b5c03325a1a4b9e5821ccf;hb=9ff17ae20effa5d54fd8481c19518123590e3bd0;hp=aafcf0662ecf778da3051a44f891f5add70d3479;hpb=63bddaad4b6578d5d9a5728cba9f2f0d552805e5;p=github%2Fshaarli%2FShaarli.git
diff --git a/plugins/markdown/README.md b/plugins/markdown/README.md
index aafcf066..bc9427e2 100644
--- a/plugins/markdown/README.md
+++ b/plugins/markdown/README.md
@@ -50,9 +50,20 @@ 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
+### HTML escape
-Markdown support HTML tags. For example:
+By default, HTML tags are escaped. You can enable HTML tags rendering
+by setting `security.markdwon_escape` to `false` in `data/config.json.php`:
+
+```json
+{
+ "security": {
+ "markdown_escape": false
+ }
+}
+```
+
+With this setting, Markdown support HTML tags. For example:
> strongstrike
@@ -60,12 +71,14 @@ 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.
+**Warning:**
+
+ * This setting might present **security risks** (XSS) on shared instances, even though tags
+ such as script, iframe, etc should be disabled.
+ * If you want to shaare HTML code, it is necessary to use inline code or code blocks.
+ * If your shaared descriptions contained HTML tags before enabling the markdown plugin,
+enabling it might break your page.
### Known issue