Skip to main content

Panflute filter to allow file includes

Project description

Pandoc filter to allow file includes.

The filter script is based on User Guide for Panflute. 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pandoc-include-0.3.2.tar.gz (2.5 kB view hashes)

Uploaded Source

Built Distributions

pandoc_include-0.3.2-py3.6.egg (4.0 kB view hashes)

Uploaded Source

pandoc_include-0.3.2-py3-none-any.whl (3.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page