Merge pull request #701 from ArthurHoaro/plugins/md-html-doc

Describe markdown HTML rendering and display a warning
This commit is contained in:
Arthur 2016-12-03 08:52:12 +01:00 committed by GitHub
commit 19b3930ff3
4 changed files with 32 additions and 3 deletions

View file

@ -37,6 +37,10 @@ em {
font-style: italic;
}
strong {
font-weight: bold;
}
/* Buttons */
.bigbutton {
background-color: #c0c0c0;
@ -1168,8 +1172,13 @@ ul.errors {
}
#pluginsadmin a {
color: #486D08;
}
#pluginsadmin a.arrow {
color: black;
}
/* 404 page */
.error-container {

View file

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

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

View file

@ -38,11 +38,11 @@ <h1>Enabled Plugins</h1>
<tr data-line="{$key}" data-order="{$counter}">
<td class="center"><input type="checkbox" name="{$key}" id="{$key}" checked="checked"></td>
<td class="center">
<a href="#"
<a href="#" class="arrow"
onclick="return orderUp(this.parentNode.parentNode.getAttribute('data-order'));">
</a>
<a href="#"
<a href="#" class="arrow"
onclick="return orderDown(this.parentNode.parentNode.getAttribute('data-order'));">
</a>