X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=plugins%2Fmarkdown%2FREADME.md;h=bc9427e23600a6f624b5c03325a1a4b9e5821ccf;hb=4fa9a3c5d83a1024678596a586afe5df14a345b5;hp=defaacd1df567d7ad6ce6d327b0bac1cbc0597e9;hpb=268a2e52659964fb7d033a1bb4d1490bf8cc49bf;p=github%2Fshaarli%2FShaarli.git
diff --git a/plugins/markdown/README.md b/plugins/markdown/README.md
index defaacd1..bc9427e2 100644
--- a/plugins/markdown/README.md
+++ b/plugins/markdown/README.md
@@ -2,33 +2,84 @@
Convert all your shaares description to HTML formatted Markdown.
-Read more about Markdown syntax here.
+[Read more about Markdown syntax](http://daringfireball.net/projects/markdown/syntax).
+
+Markdown processing is done with [Parsedown library](https://github.com/erusev/parsedown).
### Installation
-Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there.
+As a default plugin, it should already be in `tpl/plugins/` directory.
+If not, download and unpack it there.
+
The directory structure should look like:
```
-??? plugins
- ??? markdown
- ??? help.html
- ??? markdown.css
- ??? markdown.meta
- ??? markdown.php
- ??? Parsedown.php
- ??? README.md
+--- plugins
+ |--- markdown
+ |--- help.html
+ |--- markdown.css
+ |--- markdown.meta
+ |--- markdown.php
+ |--- README.md
```
-To enable the plugin, add `markdown` to your list of enabled plugins in `data/config.php`
-(`ENABLED_PLUGINS` array).
+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.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.
+
+> Note: this is a special tag, so it won't be displayed in link list.
+
+### HTML escape
+
+By default, HTML tags are escaped. You can enable HTML tags rendering
+by setting `security.markdwon_escape` to `false` in `data/config.json.php`:
+
+```json
+{
+ "security": {
+ "markdown_escape": false
+ }
+}
+```
+
+With this setting, Markdown support HTML tags. For example:
+
+ > strongstrike
+
+Will render as:
+
+> strongstrike
+
+
+**Warning:**
+
+ * This setting might present **security risks** (XSS) on shared instances, even though tags
+ such as script, iframe, etc should be disabled.
+ * If you want to shaare HTML code, it is necessary to use inline code or code blocks.
+ * If your shaared descriptions contained HTML tags before enabling the markdown plugin,
+enabling it might break your page.
+
### Known issue
#### Redirector