pandoc-include
Pandoc filter to allow file and header includes.
The filter script is based on User Guide for Panflute. This repository is to provide a simple way to install and use it.
Features
- Unix style pathname (since v0.8.2)
- Recursive include (since v0.4.0): It depends on
include-entryheader to work - Yaml header Merging (since v0.5.0): When an included file has its header, it will be merged into the current header. If there's a conflict, the original header of the current file remains.
- Header include (since v0.6.0): Use
!include-header file.yamlto include Yaml header from file.
Installation
First, install python and python-pip.
Then, use pip to install:
pip install --user pandoc-include
After installation,
make sure that the pandoc-include executable is put in the directory which is in the PATH environment.
Usage
Command
To use this filter, add to pandoc command
pandoc input.md --filter pandoc-include -o output.pdf
Header options
---
include-entry: 'path'
pandoc-options:
- --filter=pandoc-include
- <other options>
---
The pandoc-options option is a list to specify the pandoc options when recursively processing included files.
By default, the included file will inherit the pandoc-options from its parent file, unless specified in its own file.
To make the recursive includes work, --filter=pandoc-include is necessary.
The default value of pandoc-options is:
pandoc-options:
- --filter=pandoc-include
The include-entry option is to make recursive includes work.
The include-entry option is a path relative to current working directory or absolute
where the entry file (the initial file) locates.
It should be placed in the entry file only, not in the included files.
It is optional and the default include-entry value is ..
For example, to compile a file in current directory, no header is needed:
pandoc test.md --filter pandoc-include -o test.pdf
However, to compile a file not in current directory, like:
pandoc dir/test.md --filter pandoc-include -o test.pdf
The header should now be set to: include-entry: 'dir'.
Syntax
Each include statement has its own line and has the syntax:
!include somefolder/somefile
!include-header file.yaml
Or
$include somefolder/somefile
$include-header file.yaml
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 the current file's directory. Besides, unix-style pathname can used. (If the include statement is used in an included file, then the path is absolute or relative to the included file itself.)
The second syntax may lead to wrong highlighting when using a markdown editor. If it happens, use the first syntax. Also make sure that there are no circular includes.
Examples
File include
File include can be used to separate chapters into different files, or include some latex files:
---
title: Article
author: Author
toc: true
---
!include chapters/chap01.md
!include chapters/chap02.md
!include chapters/chap03.md
!include data/table.tex
Recursive include is supported from v0.4.0.
Header include
For header include, it is useful to define a header template and include it in many files.
For example, in the header.yaml, we can define basic info:
name: xxx
school: yyy
email: zzz
In the main.md, we can extend the header:
---
title: Title
---
!include-header header.yaml
# Section
Body
The main.md then is equivalent to the follow markdown:
---
title: Title
name: xxx
school: yyy
email: zzz
---
# Section
Body
License
MIT License
1 maintainer
Release files for pandoc-include 0.8.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pandoc-include-0.8.2.tar.gz | 5.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pandoc_include-0.8.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.9 kB
Release files / pandoc-include-0.8.2.tar.gz
| Download URL | pandoc-include-0.8.2.tar.gz |
|---|---|
| Size | 5.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f7a915e95cd8114a5de8f6a0332076176e63338e5171f854563e0679562be453
|
|
BLAKE2b-256 checksum How to use checksums |
4cf76c5ede886b912bbdbc5edcd83fdb09141ee1228b6462b8593c50cdddafe3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5
|
Release files / pandoc_include-0.8.2-py3-none-any.whl
| Download URL | pandoc_include-0.8.2-py3-none-any.whl |
|---|---|
| Size | 5.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f73360ddb29f8b9e32f938e31c15ce08b4743efe79f1786183940e2b010c2d5d
|
|
BLAKE2b-256 checksum How to use checksums |
2bf5b56f0985de0fabbe1a32c04f2fe26faac7ad36fb58e89aa8dc8dc7d62ed3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5
|
