https://github.com/chdemko/pandoc-latex-admonition
A pandoc filter for setting admonition on specific div or codeblock elements
https://github.com/chdemko/pandoc-latex-admonition
admonition latex pandoc-filter pypi python
Last synced: about 2 months ago
JSON representation
A pandoc filter for setting admonition on specific div or codeblock elements
- Host: GitHub
- URL: https://github.com/chdemko/pandoc-latex-admonition
- Owner: chdemko
- License: bsd-3-clause
- Created: 2017-02-01T13:41:39.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-12-24T21:37:44.000Z (5 months ago)
- Last Synced: 2025-04-02T05:08:37.669Z (2 months ago)
- Topics: admonition, latex, pandoc-filter, pypi, python
- Language: Python
- Homepage: http://pandoc-latex-admonition.readthedocs.io/
- Size: 435 KB
- Stars: 25
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Installation
============
[](https://github.com/chdemko/pandoc-latex-admonition/actions/workflows/python-package.yml)
[](https://github.com/pypa/hatch)
[](https://github.com/pre-commit/pre-commit)
[](https://pypi.org/project/black/)
[](https://coveralls.io/github/chdemko/pandoc-latex-admonition?branch=develop)
[](https://scrutinizer-ci.com/g/chdemko/pandoc-latex-admonition/)
[](https://codeclimate.com/github/chdemko/pandoc-latex-admonition/)
[](https://www.codefactor.io/repository/github/chdemko/pandoc-latex-admonition)
[](https://app.codacy.com/gh/chdemko/pandoc-latex-admonition/dashboard)
[](https://pypi.org/project/pandoc-latex-admonition/)
[](https://pypi.org/project/pandoc-latex-admonition/)
[](https://raw.githubusercontent.com/chdemko/pandoc-latex-admonition/develop/LICENSE)
[](https://pepy.tech/project/pandoc-latex-admonition)
[](https://pypi.org/project/pandoc-latex-admonition/)
[](https://pypi.org/project/pandoc-latex-admonition/)
[](https://pandoc.org/)
[](https://github.com/chdemko/pandoc-latex-admonition/releases)
[](https://github.com/chdemko/pandoc-latex-admonition/commit/develop/)
[](http://pandoc-latex-admonition.readthedocs.io/en/latest/)
[](http://pandoc-latex-admonition.readthedocs.io/en/latest/)
[](https://libraries.io/pypi/pandoc-latex-admonition)
[](http://pandoc-latex-admonition.readthedocs.io/en/latest/)
*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.
[pandoc]: http://pandoc.org/
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
~~~shell-session
$ pipx install pandoc-latex-admonition
~~~
To upgrade to the most recent release, use
~~~shell-session
$ 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](https://pipx.pypa.io/stable/).
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
~~~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.org
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.
[file an issue]: https://github.com/chdemko/pandoc-latex-admonition/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.