package pandoc-inspect
Install
Dune Dependency
Authors
Maintainers
Sources
md5=51e94d022cc795157404c0e4cde60896
sha512=2df5ab08ff1bd4dbe11dcbd572ae97ff762a0ca9ee8d4332ade4491c22a0111c3323a0982c9cb8e3158b3f1ab89dcd9d92551bf4cd4e29b8a5015e68c816edd0
Description
This pandoc filter prints pandoc's internal JSON on the standard error
Published: 29 Apr 2021
README
The OCaml pandoc library
This library is meant to help creating filters for pandoc which is tool to convert between textual formats, notably markdown and LaTeX. It is vaguely inspired of the corresponding Haskell library.
Building filters
Basically, a pandoc filter will
read JSON data from the standard input with
Yojson.Basic.from_channel
convert it to the library's standard representation with
Pandoc.of_json
transform it using the
Pandoc.map
function which recursively maps functions on various elements,convert the result to JSON with
Pandoc.of_json
,print the result on the standard output using
Yojson.Basic.to_string
.
Once you have build your filter (say, myfilter
) you can use it to transform pandoc documents while they are being processed by using the --filter
commandline argument. For instance:
pandoc --filter=myfilter file.md -o file.pdf
Examples
Some examples are provided in the examples directory for you convenience (or because I needed those).
pandoc-abbreviations
: adds non-breakable spaces after abbreviations (listed inabbreviations
file). Pandoc already does this natively, but it does not play well with other plugins.pandoc-crossref
: handles cross-references in LaTeX. It replaces references of the form#chap:bla
and#sec:bli
to\cref{chap:bla}
and ``cref{sec:bli}` respectively.pandoc-include
: includes other documents. It replaces!include "file"
by the contents of the file
file
and```{.ocaml include="test.ml" from=2 to=5} ```
by the contents of the file
test.ml
between lines 2 and 5 (negative values forto
are counted from the end of the file). Useful for including small code snippets.pandoc-inspects
: acts as the identity plugin, but prints the JSON output given by pandoc on the standard error. Useful for debugging and adding missing features to the library.
Bugs and features requests
The code is simple and stable enough for me but some features are missing. Feel free to fill bug reports or submit pull requests.