Installation

pandoc-latex-admonition is a pandoc filter for adding admonition to divs or codeblocks elements.

It uses the tcolorbox LaTeX package to generate admonitions and the footnote LaTeX package to handle correctly footnotes in admonition.

Instructions

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

Install pandoc-latex-admonition using the bash command

$ pipx install pandoc-latex-admonition

To upgrade to the most recent release, use

$ pipx upgrade pandoc-latex-admonition

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

• tcolorbox
• footnote
• xcolor
• ifthen

LaTeX packages. On linux you have to install some extra libraries before pandoc-latex-admonition. 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-latex-admonition, 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.