aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMarin Ivanov <[email protected]>2013-04-05 15:02:20 +0300
committerMarin Ivanov <[email protected]>2013-04-05 15:02:20 +0300
commitb1561cfc87fd3c7c8db5208501aaec28f90243d4 (patch)
tree8b1e97c5295caefc88e26c10c42696dcdadac92b /README.md
parentd96bbb2f64217db0cae1a815da028890c14dad15 (diff)
Hello world.
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2195942..a7dbc20 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,10 @@
jekyll-wikilinks-plugin
=======================
-A plugin for Jekyll to process Wikipedia-like links in Maruku markdown \ No newline at end of file
+A plugin for Jekyll to process Wikipedia style links in Maruku markdown. It supports the short `[[name]]` link syntax and also `[[name|Title]]`, where `name` is eiter a name of a page or of a post and `Title` is optional text that the link will show. If short syntax is used, the text for the link will be either the title of the page/post or the name of the page/post.
+
+Install
+-------
+
+Plugin should be placed in `_plugins` directory of the jekyll site root.
+