https://github.com/chdemko/pandoc-numbering
A pandoc filter for numbering all kinds of things.
https://github.com/chdemko/pandoc-numbering
numbering pandoc-filter pypi python
Last synced: 4 months ago
JSON representation
A pandoc filter for numbering all kinds of things.
- Host: GitHub
- URL: https://github.com/chdemko/pandoc-numbering
- Owner: chdemko
- License: bsd-3-clause
- Created: 2015-11-04T17:34:28.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-30T17:45:46.000Z (9 months ago)
- Last Synced: 2024-10-30T18:36:54.994Z (9 months ago)
- Topics: numbering, pandoc-filter, pypi, python
- Language: Python
- Homepage: http://pandoc-numbering.readthedocs.io/
- Size: 1.1 MB
- Stars: 32
- Watchers: 5
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Install
=======
[](https://github.com/chdemko/pandoc-numbering/actions/workflows/python-package.yml)
[](https://github.com/pypa/hatch)
[](https://github.com/pre-commit/pre-commit)
[](https://pypi.org/project/black/)
[](https://github.com/astral-sh/ruff)
[](https://github.com/python/mypy)
[](https://coveralls.io/github/chdemko/pandoc-numbering?branch=develop)
[](https://scrutinizer-ci.com/g/chdemko/pandoc-numbering/)
[](https://codeclimate.com/github/chdemko/pandoc-numbering/)
[](https://www.codefactor.io/repository/github/chdemko/pandoc-numbering)
[](https://app.codacy.com/gh/chdemko/pandoc-numbering/dashboard)
[](https://pypi.org/project/pandoc-numbering/)
[](https://pypi.org/project/pandoc-numbering/)
[](https://raw.githubusercontent.com/chdemko/pandoc-numbering/develop/LICENSE)
[](https://pepy.tech/project/pandoc-numbering)
[](https://pypi.org/project/pandoc-numbering/)
[](https://pypi.org/project/pandoc-numbering/)
[](https://pandoc.org/)
[](https://github.com/chdemko/pandoc-numbering/releases)
[](https://github.com/chdemko/pandoc-numbering/commit/develop/)
[](http://pandoc-numbering.readthedocs.io/en/latest/)
[](http://pandoc-numbering.readthedocs.io/en/latest/)
[](https://libraries.io/pypi/pandoc-numbering)
[](http://pandoc-numbering.readthedocs.io/en/latest/)
*pandoc-numbering* is a [pandoc] filter for numbering all kinds of things.
[pandoc]: http://pandoc.org/
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
~~~shell-session
$ pipx install pandoc-numbering
~~~
To upgrade to the most recent release, use
~~~shell-session
$ 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](https://pipx.pypa.io/stable/).
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
~~~shell-session
$ sudo apt-get install texlive-latex-extra
~~~
[python]: https://www.python.org/
[on Windows]: https://www.python.org/downloads/windows/
[PyPI]: https://pypi.python.org/pypi
Getting Help
------------
If you have any difficulties with *pandoc-numbering*, please feel welcome to
[file an issue] on github so that we can help.
[file an issue]: https://github.com/chdemko/pandoc-numbering/issues
Contribute
==========
Instructions
------------
Install `hatch`, then run
~~~shell-session
$ 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
~~~shell-session
$ 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.