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.

Leading ./ or ../ is necessary to make it work properly.

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.1.tar.gz (2.5 kB view details)

Uploaded Source

Built Distributions

pandoc_include-0.3.1-py3.6.egg (4.0 kB view details)

Uploaded Source

pandoc_include-0.3.1-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file pandoc-include-0.3.1.tar.gz.

File metadata

  • Download URL: pandoc-include-0.3.1.tar.gz
  • Upload date:
  • Size: 2.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for pandoc-include-0.3.1.tar.gz
Algorithm Hash digest
SHA256 ae0ff26ea1316caf7178a97e1c3524d72a251d949fecb70dd4676e96f248df84
MD5 3f8a6d2957c3c10e027bacfe7cfa8310
BLAKE2b-256 76a212d36f32a81e2b95134fc95c1aa67e874d86e87cbd7497967eddba84b2ff

See more details on using hashes here.

File details

Details for the file pandoc_include-0.3.1-py3.6.egg.

File metadata

  • Download URL: pandoc_include-0.3.1-py3.6.egg
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for pandoc_include-0.3.1-py3.6.egg
Algorithm Hash digest
SHA256 a358b28b26935cb428ac1b1863620c2a0e2afc21ec285f96e71d036fd1643e42
MD5 42da5cc552604263809d867029f943e2
BLAKE2b-256 ad11c88c1ae7bd3bc93e267b9f7a5f4038438cd5b4f60a90fba0a9102ee6e8b7

See more details on using hashes here.

File details

Details for the file pandoc_include-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: pandoc_include-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for pandoc_include-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ff7aafe2506b5d579c374785bd557c925c80d8d0b0d3ec6cc03bec66045f16cd
MD5 d20035aa7b11523a4a256606f94310ff
BLAKE2b-256 b79b3fe08207d09d0c37885edb2784f178e9ad01fd04f4741157ea4446e47fa2

See more details on using hashes here.

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