/pandoc-numbering

A pandoc filter for numbering all kinds of things.

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Install

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

pandoc-numbering is a pandoc filter for numbering all kinds of things.

Instructions

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

Install pandoc-numbering using the bash command

$ pipx install pandoc-numbering

To upgrade to the most recent release, use

$ pipx upgrade pandoc-numbering

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.

Make sure you have the

  • tocloft

LaTeX package. On linux you have to install some extra libraries before pandoc-numbering. On a Debian-based system (including Ubuntu), you can install it as root using

$ sudo apt-get install texlive-latex-extra

Getting Help

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

Contribute

Instructions

Install poetry, then run

$ poetry install
$ poetry shell

And submit your changes. When you commit, hooks will be executed to check your code.