Fixes forced git changes

[github/shaarli/Shaarli.git] / plugins / markdown / README.md

diff --git a/plugins/markdown/README.md b/plugins/markdown/README.md
index 22d0af356b92daa493aaa9abd60acaa880b0088f..defaacd1df567d7ad6ce6d327b0bac1cbc0597e9 100644 (file)
--- a/plugins/markdown/README.md
+++ b/plugins/markdown/README.md
@@ -1,51 +1,51 @@
-## Markdown Shaarli plugin\r
-\r
-Convert all your shaares description to HTML formatted Markdown.\r
-\r
-Read more about Markdown syntax here.\r
-\r
-### Installation\r
-\r
-Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there.\r
-The directory structure should look like:\r
-\r
-```\r
-??? plugins\r
-    ??? markdown\r
-        ??? help.html\r
-        ??? markdown.css\r
-        ??? markdown.meta\r
-        ??? markdown.php\r
-        ??? Parsedown.php\r
-        ??? README.md\r
-```\r
-\r
-To enable the plugin, add `markdown` to your list of enabled plugins in `data/config.php`\r
-(`ENABLED_PLUGINS` array).\r
-\r
-This should look like:\r
-\r
-```\r
-$GLOBALS['config']['ENABLED_PLUGINS'] = array('qrcode', 'any_other_plugin', 'markdown')\r
-```\r
-\r
-### Known issue\r
-\r
-#### Redirector\r
-\r
-If you're using a redirector, you *need* to add a space after a link,\r
-otherwise the rest of the line will be `urlencode`.\r
-\r
-```\r
-[link](http://domain.tld)-->test\r
-```\r
-\r
-Will consider `http://domain.tld)-->test` as URL.\r
-\r
-Instead, add an additional space.\r
-\r
-```\r
-[link](http://domain.tld) -->test\r
-```\r
-\r
-> Won't fix because a `)` is a valid part of an URL.\r
+## Markdown Shaarli plugin
+
+Convert all your shaares description to HTML formatted Markdown.
+
+Read more about Markdown syntax here.
+
+### Installation
+
+Clone this repository inside your `tpl/plugins/` directory, or download the archive 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, 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')
+```
+
+### 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.