Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update markdown plugin README documentation

Browse source 
* Add the `.nomarkdown` section.
  * Update misleading statements.
This commit is contained in:
ArthurHoaro 2016-03-26 16:43:14 +01:00
parent 3ce20d9e84
commit 340252ae5d
1 changed files with 23 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
plugins/markdown/README.md
View file

@ -2,25 +2,31 @@
Convert all your shaares description to HTML formatted Markdown. 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 ### 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: The directory structure should look like:
``` ```
??? plugins --- plugins
   ??? markdown |--- markdown
??? help.html |--- help.html
??? markdown.css |--- markdown.css
??? markdown.meta |--- markdown.meta
??? markdown.php |--- markdown.php
??? Parsedown.php |--- Parsedown.php
   ??? README.md |--- README.md
``` ```
To enable the plugin, add `markdown` to your list of enabled plugins in `data/config.php` 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). (`ENABLED_PLUGINS` array).
This should look like: This should look like:
@ -29,6 +35,12 @@ This should look like:
$GLOBALS['config']['ENABLED_PLUGINS'] = array('qrcode', 'any_other_plugin', 'markdown') $GLOBALS['config']['ENABLED_PLUGINS'] = array('qrcode', 'any_other_plugin', 'markdown')
``` ```
### No Markdown tag
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.
### Known issue ### Known issue
#### Redirector #### Redirector