Yet another pandoc filter to include external code files.
Project description
Pandoc-import-code
Pandoc filter to include external code files as fenced code blocks using the Vuepress syntax.
Install
To install pandoc-import-code, open the command line and type:
pip install pandoc-import-code
Python 3.6+ and PyPy3 are supported.
Usage
:warning: pandoc-import-code requires Pandoc 2.11+, as it relies on Panflute 2
Command
$ pandoc source.md --filter pandoc-import-code -o output.md
Syntax
<<< @/<path>#[region]
- path : path to a code file to import
- relative to the pandoc command working directory
- region : custom region name for partial import
- syntax inspired by VS Code
Example
$ pandoc docs/index.md --filter pandoc-import-code -o out.md
Source (./docs/index.md)
# Code Sample
<<< @/samples/hello-world.html#title
Code sample (./samples/hello-world.html)
<!DOCTYPE html>
<html lang="en">
<head>
<title>Document</title>
</head>
<body>
<!-- #region title -->
<h1>
Hello World!
</h1>
<!-- #endregion title -->
</body>
</html>
Output (./out.md)
# Code Sample
``` {.html}
<h1>
Hello World
</h1>
```
Limitations
- as line-highlighting isn't supported by pandoc, any
{1-2}parameter will be ignored
Dev Install
After cloning the repository and opening the pandoc-import-code folder:
python setup.py install: installs the package locally
python setup.py develop: installs locally with a symlink so changes are
automatically updated
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for pandoc_import_code-1.0.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 74d25638553a0dccb348ac748b4cf27d9f710c22da57ab5e09ef9cdc778447ba |
|
| MD5 | 19e76e4e5d09d0a6152f2a3041dc7d93 |
|
| BLAKE2b-256 | b732ab21a9a32966a6337791150da7cc15c5e91c82af059869149c755f03f581 |
