Metadata-Version: 2.1
Name: pandoc-include
Version: 0.3.2
Summary: Panflute filter to allow file includes
Home-page: https://github.com/DCsunset/pandoc-include
Author: DCsunset
Author-email: DCsunset@protonmail.com
License: MIT
Platform: UNKNOWN
Requires-Dist: panflute (>=1)

pandoc-include
==============

Pandoc filter to allow file includes.

The filter script is based on `User Guide for
Panflute <http://scorreia.com/software/panflute/guide.html#using-the-included-batteries>`__.
This repository is to provide a simple way to install and use it.

Installation
------------

Use pip to install:

::

   pip install --user pandoc-include

Usage
-----

Command
~~~~~~~

To use this filter, add to pandoc command

::

   pandoc input.md --filter pandoc-include -o output.pdf

Syntax
~~~~~~

Each include statement has its own line and has the syntax:

::

   !include somefolder/somefile

Or

::

   $include somefolder/somefile

Each include statement must be in its own paragraph. That is, in its own
line and separated by blank lines.

The path can be either absolute or relative to current file’s directory.

Recursive include is supported from v0.3.1.

If no extension was given, “.md” is assumed.

**Note:** The second syntax may lead to wrong highlighting when using a
markdown editor. If it happens, use the first syntax.

License
-------

MIT License


