From 3d8f5cf84b8baa4a212f5089633af7c640609b62 Mon Sep 17 00:00:00 2001
From: ArthurHoaro <arthur@hoa.ro>
Date: Thu, 1 Dec 2016 11:40:24 +0100
Subject: Describe markdown HTML rendering and display a warning

Fixes #688
---
 plugins/markdown/README.md     | 17 +++++++++++++++++
 plugins/markdown/markdown.meta |  5 ++++-
 2 files changed, 21 insertions(+), 1 deletion(-)

(limited to 'plugins')

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:
+
+    > <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
diff --git a/plugins/markdown/markdown.meta b/plugins/markdown/markdown.meta
index e3904ed8..8df2ed0b 100644
--- a/plugins/markdown/markdown.meta
+++ b/plugins/markdown/markdown.meta
@@ -1 +1,4 @@
-description="Render shaare description with Markdown syntax."
+description="Render shaare description with Markdown syntax.<br><strong>Warning</strong>:
+If your shaared descriptions containing HTML tags before enabling the markdown plugin,
+enabling it might break your page.
+See the <a href=\"https://github.com/shaarli/Shaarli/tree/master/plugins/markdown#html-rendering\">README</a>."
-- 
cgit v1.2.3