Skip to content

chdemko/pandoc-numbering

Repository files navigation

Install

Python package Hatch project 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-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 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.