Describe markdown HTML rendering and display a warning

Fixes 
This commit is contained in:
ArthurHoaro 2016-12-01 11:40:24 +01:00
parent 76fb679e38
commit 3d8f5cf84b
4 changed files with 32 additions and 3 deletions
plugins/markdown

View file

@ -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

View file

@ -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>."