pandoc-latex-tip

license icon by Daniel Bruce, format icon by Picol, status icon by Just Icon, code style icon by Google Material Design icons

pandoc-latex-tip is a pandoc filter for adding icon tooltips in the margin using popular icon collections. It uses the icon_font_to_png package to generate on-fly images.

Documentation

See the Read the docs pages.

Usage

To apply the filter, use the following option with pandoc:

--filter pandoc-latex-tip

Installation

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

Install pandoc-latex-tip as root using the bash command

pip install pandoc-latex-tip

To upgrade to the most recent release, use

pip install --upgrade pandoc-latex-tip

To upgrade the icon collections add the --force and --no-cache flags

pip install --upgrade --force --no-cache pandoc-latex-tip

To upgrade to the current code, use

pip install --upgrade --force --no-cache git+https://github.com/chdemko/pandoc-latex-tip

pip is a script that downloads and installs modules from the Python Package Index, PyPI. It should come installed with your python distribution. If you are running linux, pip may be bundled separately. On a Debian-based system (including Ubuntu), you can install it as root using

apt-get update
apt-get install python-pip

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

apt-get build-dep python-imaging
apt-get install libjpeg8 libjpeg62-dev libfreetype6 libfreetype6-dev

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.