summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md22
1 files changed, 12 insertions, 10 deletions
diff --git a/README.md b/README.md
index 89a0439..b6d091c 100644
--- a/README.md
+++ b/README.md
@@ -3,14 +3,14 @@
An "external" (XML-RPC) [IkiWiki][] plugin for rendering Markdown
fragments with [Pandoc][], replacing the default [mdwn][] plugin.
-[ikiwiki-pandoc][] has the same purpose as this plugin, and is easier
-to install, more mature, and more featureful. However, fast-pandoc
-can be significantly faster, especially if you use directives like
-`\[[!table]]` and `\[[!report]]` that generate many Markdown fragments
-that IkiWiki will htmlize individually. Whereas [ikiwiki-pandoc][]
-will fork+exec the pandoc binary for every fragment, fast-pandoc
-embeds pandoc in a co-process that runs alongside IkiWiki. At
-[SFLC][], switching to fast-pandoc sped up rebuilds of an internal
+You should probably try [ikiwiki-pandoc][] first, as it's easier to
+install, more mature, and more featureful than this plugin. However,
+ikiwiki-fast-pandoc can be significantly faster, especially if you use
+directives like [table][] and [report][] that generate many Markdown
+fragments that IkiWiki will htmlize individually. Whereas
+[ikiwiki-pandoc][] will fork+exec the pandoc binary for every
+fragment, ikiwiki-fast-pandoc embeds pandoc in a co-process that runs
+alongside IkiWiki. At [SFLC][], this sped up rebuilds of an internal
wiki by 25-30%.
[IkiWiki]: https://ikiwiki.info/
@@ -18,19 +18,21 @@ wiki by 25-30%.
[mdwn]: https://ikiwiki.info/plugins/mdwn/
[ikiwiki-pandoc]: https://github.com/sciunto-org/ikiwiki-pandoc
[SFLC]: https://softwarefreedom.org
+[table]: https://ikiwiki.info/ikiwiki/directive/table/
+[report]: http://ikiwiki.info/plugins/contrib/report/ikiwiki/directive/report/
## Build and install
Install git and [Haskell Stack](http://haskellstack.org/), then do:
```
-git clone git://code.softwarefreedom.org/git/fast-pandoc
+git clone git://code.softwarefreedom.org/git/ikiwiki-fast-pandoc
cd fast-pandoc
stack build
```
To make fast-pandoc available to your wiki, locate its "extra library
-and plugin directory" (the `libdir` option in the *.setup file),
+and plugin directory" (the `libdir` option in the `*.setup` file),
create a `plugins` subdirectory (if it doesn't already exist), and
install the `fast-pandoc` binary into it. (See also
<https://ikiwiki.info/plugins/install/>.) Many wikis put their libdir