A pandoc filter for adding admonition in LaTeX
Project description
Installation
pandoc-latex-admonition is a pandoc filter for adding admonition
to div
s or codeblock
s 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file pandoc_latex_admonition-1.3.4.3-py3-none-any.whl
.
File metadata
- Download URL: pandoc_latex_admonition-1.3.4.3-py3-none-any.whl
- Upload date:
- Size: 9.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.27.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26b886636851f9c960912b6c10def2495ee964d23d81b41200919ff3c69306f7 |
|
MD5 | c42c0cdc8eb86e91422b9f799295f6f3 |
|
BLAKE2b-256 | 51042fcd9bac0e61ee14d1f61763764a45825feda2f9cccd5e81f4fd7912900c |