pandoc-latex-tip 3.1.0.0

A pandoc filter for adding icons on specific elements

Installation

pandoc-latex-tip, designed to be used in conjuction with pandoc-latex-admonition, is a pandoc filter for adding icon tooltips in the margin using popular icon collections.

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

$ pipx install pandoc-latex-tip

To upgrade to the most recent release, use

$ 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.

Make sure you have required packages for Pillow installation. 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

$ sudo apt-get install python3-pil

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.

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.

Download font files

Run

$ hatch run python download.py

to download font files.

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.