diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 7 insertions, 1 deletions
@@ -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. + |