https://github.com/chdemko/pandoc-latex-tip
A pandoc filter for adding tip in LaTeX
https://github.com/chdemko/pandoc-latex-tip
fontawesome icon latex pandoc-filter pypi python tips x11
Last synced: about 1 month ago
JSON representation
A pandoc filter for adding tip in LaTeX
- Host: GitHub
- URL: https://github.com/chdemko/pandoc-latex-tip
- Owner: chdemko
- License: bsd-3-clause
- Created: 2016-04-29T17:42:37.000Z (about 9 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-13T11:34:20.000Z (3 months ago)
- Last Synced: 2025-04-13T17:44:13.251Z (2 months ago)
- Topics: fontawesome, icon, latex, pandoc-filter, pypi, python, tips, x11
- Language: Python
- Homepage: http://pandoc-latex-tip.readthedocs.io
- Size: 2.68 MB
- Stars: 9
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Installation
============
[](https://github.com/chdemko/pandoc-latex-tip/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-tip?branch=develop)
[](https://scrutinizer-ci.com/g/chdemko/pandoc-latex-tip/)
[](https://codeclimate.com/github/chdemko/pandoc-latex-tip/)
[](https://www.codefactor.io/repository/github/chdemko/pandoc-latex-tip)
[](https://app.codacy.com/gh/chdemko/pandoc-latex-tip/dashboard)
[](https://pypi.org/project/pandoc-latex-tip/)
[](https://pypi.org/project/pandoc-latex-tip/)
[](https://raw.githubusercontent.com/chdemko/pandoc-latex-tip/develop/LICENSE)
[](https://pepy.tech/project/pandoc-latex-tip)
[](https://pypi.org/project/pandoc-numbering/)
[](https://pypi.org/project/pandoc-latex-tip/)
[](https://pandoc.org/)
[](https://github.com/chdemko/pandoc-latex-tip/releases)
[](https://github.com/chdemko/pandoc-latex-tip/commit/develop/)
[](http://pandoc-latex-tip.readthedocs.io/en/latest/)
[](http://pandoc-latex-tip.readthedocs.io/en/latest/)
[](https://libraries.io/pypi/pandoc-latex-tip)
[](http://pandoc-latex-tip.readthedocs.io/en/latest/)
*pandoc-latex-tip*, designed to be used in conjuction with
[*pandoc-latex-admonition*](https://github.com/chdemko/pandoc-latex-admonition),
is a [pandoc] filter for adding icon tooltips in the margin
using popular icon collections.
[pandoc]: http://pandoc.org/
Instructions
------------
*pandoc-latex-tip* 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-tip* using the bash command
~~~shell-session
$ pipx install pandoc-latex-tip
~~~
To upgrade to the most recent release, use
~~~shell-session
$ pipx upgrade pandoc-latex-tip
~~~
`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 required packages for
[Pillow installation](https://pillow.readthedocs.io/en/stable/installation/index.html).
On linux you have to install some extra libraries
**before** *pandoc-latex-tip*. On a Debian-based system (including Ubuntu),
you can install it as root using
~~~shell-session
$ sudo apt-get install python3-pil
~~~
[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-tip, please feel welcome to
[file an issue] on github so that we can help.
[file an issue]: https://github.com/chdemko/pandoc-latex-tip/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.
Download font files
-------------------
Run
~~~shell-session
$ hatch run python download.py
~~~
to download font files.
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.