From b1561cfc87fd3c7c8db5208501aaec28f90243d4 Mon Sep 17 00:00:00 2001 From: Marin Ivanov Date: Fri, 5 Apr 2013 15:02:20 +0300 Subject: Hello world. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'README.md') 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. + -- cgit v1.2.3