aboutsummaryrefslogtreecommitdiffhomepage
path: root/plugins/markdown/README.md
diff options
context:
space:
mode:
authorArthur <arthur@hoa.ro>2016-12-03 08:52:12 +0100
committerGitHub <noreply@github.com>2016-12-03 08:52:12 +0100
commit19b3930ff39384fef890fb8949792a07e73151ae (patch)
treebc386ea21e60b5d84b06919ef8e21d272f480ef6 /plugins/markdown/README.md
parent6781465fda8ad5dc3a37439446d4ff1100f1fd39 (diff)
parent3d8f5cf84b8baa4a212f5089633af7c640609b62 (diff)
downloadShaarli-19b3930ff39384fef890fb8949792a07e73151ae.tar.gz
Shaarli-19b3930ff39384fef890fb8949792a07e73151ae.tar.zst
Shaarli-19b3930ff39384fef890fb8949792a07e73151ae.zip
Merge pull request #701 from ArthurHoaro/plugins/md-html-doc
Describe markdown HTML rendering and display a warning
Diffstat (limited to 'plugins/markdown/README.md')
-rw-r--r--plugins/markdown/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/plugins/markdown/README.md b/plugins/markdown/README.md
index 196005e7..aafcf066 100644
--- a/plugins/markdown/README.md
+++ b/plugins/markdown/README.md
@@ -50,6 +50,23 @@ If the tag `nomarkdown` is set for a shaare, it won't be converted to Markdown s
50 50
51> Note: this is a special tag, so it won't be displayed in link list. 51> Note: this is a special tag, so it won't be displayed in link list.
52 52
53### HTML rendering
54
55Markdown support HTML tags. For example:
56
57 > <strong>strong</strong><strike>strike</strike>
58
59Will render as:
60
61> <strong>strong</strong><strike>strike</strike>
62
63If you want to shaare HTML code, it is necessary to use inline code or code blocks.
64
65**If your shaared descriptions containing HTML tags before enabling the markdown plugin,
66enabling it might break your page.**
67
68> Note: HTML tags such as script, iframe, etc. are disabled for security reasons.
69
53### Known issue 70### Known issue
54 71
55#### Redirector 72#### Redirector