MyShaarli/plugins/markdown
ArthurHoaro 340252ae5d Update markdown plugin README documentation
* Add the `.nomarkdown` section.
  * Update misleading statements.
2016-03-26 16:43:14 +01:00
..
help.html Fixes forced git changes 2016-01-31 19:22:14 +01:00
markdown.css adding styles for code & pre tags 2016-02-19 09:58:01 -03:00
markdown.meta Fixes forced git changes 2016-01-31 19:22:14 +01:00
markdown.php Markdown: Add the 'meta-tag' .nomarkdown which prevent a shaare from being parsed with markdown 2016-03-21 18:46:34 +01:00
Parsedown.php PLUGIN Markdown 2016-01-03 17:36:10 +01:00
README.md Update markdown plugin README documentation 2016-03-26 16:43:14 +01:00

Markdown Shaarli plugin

Convert all your shaares description to HTML formatted Markdown.

Read more about Markdown syntax.

Markdown processing is done with Parsedown library.

Installation

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

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

This should look like:

$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

Redirector

If you're using a redirector, you need to add a space after a link, otherwise the rest of the line will be urlencode.

[link](http://domain.tld)-->test

Will consider http://domain.tld)-->test as URL.

Instead, add an additional space.

[link](http://domain.tld) -->test

Won't fix because a ) is a valid part of an URL.