The pandoc-include package

[Tags:library, mit, program]

A Pandoc filter that replaces include labeled Code Blocks with the contents of the referenced Markdown files. Even nested, recursive includes.


[Skip to Readme]

Properties

Versions 0.0.1
Change log CHANGELOG.md
Dependencies base (>=4.6 && <5), directory, pandoc (>=1.13.0.0), pandoc-types (>=1.12.0.0), text (>=0.11) [details]
License MIT
Copyright (c) 2015 Dániel Stein
Author Dániel Stein <daniel@stein.hu>
Maintainer Dániel Stein <daniel@stein.hu>
Category Text
Home page https://github.com/steindani/pandoc-include
Bug tracker https://github.com/steindani/pandoc-include/issues
Source repository head: git clone git://github.com/steindani/pandoc-include.git
Uploaded Tue Dec 8 13:55:44 UTC 2015 by steindani
Distributions NixOS:0.0.1
Downloads 209 total (22 in the last 30 days)
Votes
0 []
Status Docs not available [build log]
Last success reported on 2016-11-29 [all 3 reports]
Hackage Matrix CI

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for pandoc-include

Readme for pandoc-include-0.0.1

pandoc-include

A Pandoc filter that replaces include labeled Code Blocks with the contents of the referenced files. Even nested, recursive includes.

Based on the scripting tutorial for Pandoc: http://pandoc.org/scripting.html#include-files

Format

The Code Blocks like the following will include every file in a new line. The reference paths should be either absolute or relative to the folder where the pandoc command will be executed.

```include
/absolute/file/path.md
relative/to/the/command/root.md
#do/not/include/this.md
```

If the file does not exist, it will be skipped completely. No warnings, no residue, nothing. Putting an # as the first character in the line will make the filter skip that file.

For now the nested includes only work for two levels, after that the source will be inserted and not parsed.

Note: the metadata from the included source files are discarded.

Installation

One could either install it using the Cabal packaging system by running:

cabal update
cabal install pandoc-include

Or it is also possible to use the pipe method using the source code described in the Usage section.

Usage

In order to use this Pandoc filter, one has to include it into the Pandoc transformation workflow. This can be done by using the --filter parameter, like so:

pandoc --from markdown --to latex --filter pandoc-include input.md

All this does in the background is pipelining the output of Pandoc and the last filter into the standard input of the include filter and using its output as the next filter's input:

pandoc --from markdown --to json input.md | runhaskell IncludeFilter.hs | pandoc --from json --to latex

License

Copyright ©2015 Dániel Stein

Source code is released under the Terms and Conditions of MIT License.