Skip to main content

A pandoc filter for including file in block code

Project description

Installation

Python package pre-commit Code style: black Coveralls Scrutinizer Code Climate CodeFactor Codacy PyPI version PyPI format License Downloads Development Status Python version Pandoc version Latest release Last commit Repo Size Code Size Source Rank Docs

pandoc-codeblock-include is a pandoc filter for including files in CodeBlock elements.

Instructions

pandoc-codeblock-include requires python, a programming language that comes pre-installed on linux and Mac OS X, and which is easily installed on Windows.

Install pandoc-codeblock-include using the bash command

$ pipx install pandoc-codeblock-include

To upgrade to the most recent release, use

$ pipx upgrade pandoc-codeblock-include

pipx is a script to install and run python applications in isolated environments from the Python Package Index, PyPI. It can be installed using instructions given here.

Getting Help

If you have any difficulties with pandoc-codeblock-include, please feel welcome to file an issue on github so that we can help.

Contribute

Instructions

Install hatch, then run

$ hatch run pip install pre-commit
$ hatch run pre-commit install

to install pre-commit before working on your changes.

Tests

When your changes are ready, run

$ hatch test
$ hatch fmt --check
$ hatch run lint:check
$ hatch run docs:build
$ hatch build -t wheel

for running the tests, checking the style, building the documentation and building the wheel.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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