From: Arthur <arthur@hoa.ro>
Date: Sat, 3 Dec 2016 07:52:12 +0000 (+0100)
Subject: Merge pull request #701 from ArthurHoaro/plugins/md-html-doc
X-Git-Tag: v0.8.1~7
X-Git-Url: https://git.immae.eu/?a=commitdiff_plain;h=19b3930ff39384fef890fb8949792a07e73151ae;hp=-c;p=github%2Fshaarli%2FShaarli.git

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

Describe markdown HTML rendering and display a warning
---

19b3930ff39384fef890fb8949792a07e73151ae
diff --combined plugins/markdown/README.md
index 196005e7,c64a831a..aafcf066
--- a/plugins/markdown/README.md
+++ b/plugins/markdown/README.md
@@@ -20,36 -20,44 +20,53 @@@ The directory structure should look lik
       |--- markdown.css
       |--- markdown.meta
       |--- markdown.php
 -     |--- Parsedown.php
       |--- README.md
  ```
  
  To enable the plugin, just check it in the plugin administration page.
  
 -You can also add `markdown` to your list of enabled plugins in `data/config.php`
 -(`ENABLED_PLUGINS` array).
 +You can also add `markdown` to your list of enabled plugins in `data/config.json.php`
 +(`general.enabled_plugins` list).
  
  This should look like:
  
  ```
 -$GLOBALS['config']['ENABLED_PLUGINS'] = array('qrcode', 'any_other_plugin', 'markdown')
 +"general": {
 +  "enabled_plugins": [
 +    "markdown",
 +    [...]
 +  ],
 +}
  ```
  
 +Parsedown parsing library is imported using Composer. If you installed Shaarli using `git`,
 +or the `master` branch, run
 +
 +    composer update --no-dev --prefer-dist
 +
  ### No Markdown tag
  
 -If the tag `.nomarkdown` is set for a shaare, it won't be converted to Markdown syntax.
 +If the tag `nomarkdown` is set for a shaare, it won't be converted to Markdown syntax.
   
 -> Note: it's a private tag (leading dot), so it won't be displayed to visitors.
 +> 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