aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn MacFarlane <fiddlosopher@gmail.com>2013-07-23 22:52:15 -0700
committerJohn MacFarlane <fiddlosopher@gmail.com>2013-07-23 23:02:47 -0700
commit85dacbb282f34dc45a810d7c7b5a2d639b70e1f5 (patch)
tree2b6e1bd5086907fb006673bc47986a01ca04a0cf /README
parent5592666ca44aa0d027cd95bf11cff09825896584 (diff)
downloadpandoc-85dacbb282f34dc45a810d7c7b5a2d639b70e1f5.tar.gz
Added `--filter` option.
This makes it easier to use JSON filters. Instead of doing pandoc -t json | ./filter | pandoc -f json you can just do pandoc --filter ./filter
Diffstat (limited to 'README')
-rw-r--r--README8
1 files changed, 8 insertions, 0 deletions
diff --git a/README b/README
index d9b003344..83873a92e 100644
--- a/README
+++ b/README
@@ -259,6 +259,14 @@ Reader options
require different kinds of images. Currently this option only affects
the markdown and LaTeX readers.
+`--filter=`*PATH*
+: Specify an executable to be used as a filter transforming the
+ Pandoc AST after the input is parsed and before the output is
+ written. The executable should read JSON from stdin and write
+ JSON to stdout. The JSON must be formatted like pandoc's own
+ JSON input and output. Filters may be most easily created in Haskell,
+ using the utility function `toJsonFilter` from `Text.Pandoc`.
+
`--normalize`
: Normalize the document after reading: merge adjacent
`Str` or `Emph` elements, for example, and remove repeated `Space`s.