blob: b6d091c291f1816eb0a64e6c1d708dc232a0b46f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
# ikiwiki-fast-pandoc
An "external" (XML-RPC) [IkiWiki][] plugin for rendering Markdown
fragments with [Pandoc][], replacing the default [mdwn][] plugin.
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/
[Pandoc]: https://pandoc.org/
[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/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),
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
at `~/.ikiwiki`.
```
mkdir -p ~/.ikiwiki/plugins/
stack install --local-bin-path ~/.ikiwiki/plugins
```
Finally, add `fast-pandoc` to the `add_plugins` list:
```
ikiwiki --changesetup ~/wiki.setup --plugin fast-pandoc
```
|
