Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 9.11 KB

README.md

File metadata and controls

80 lines (53 loc) · 9.11 KB

pandoc-numbering

Python package Coveralls Scrutinizer PyPI version PyPI format kandi X-Ray License Repo Size Python version Downloads Source Rank Development Status Docs Code style: black

license icon by Daniel Bruce, format icon by Picol, status icon by Just Icon, code style icon by Google Material Design icons

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

Documentation

See the Read the docs pages.

Usage

To apply the filter, use the following option with pandoc:

--filter pandoc-numbering

Installation

pandoc-numbering requires python, a programming language that comes pre-installed on linux and Mac OS X, and which is easily installed on Windows. Either python 2.7 or 3.x will do.

Install pandoc-numbering as root using the bash command

pip install pandoc-numbering

To upgrade to the most recent release, use

pip install --upgrade pandoc-numbering

To upgrade to the current code, use

pip install --upgrade --force --no-cache git+https://github.com/chdemko/pandoc-numbering

pip is a script that downloads and installs modules from the Python Package Index, PyPI. It should come installed with your python distribution. If you are running linux, pip may be bundled separately. On a Debian-based system (including Ubuntu), you can install it as root using

apt-get update
apt-get install python-pip

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

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.