Skip to main content

A pandoc filter for adding tip in LaTeX

Project description

Build Status Coveralls Scrutinizer PyPI version PyPI format License Downloads Python version Development Status

pandoc-latex-tip is a pandoc filter for adding icon tooltips in the margin using the Font-Awesome icons collection 4.7.0 (Font Awesome by Dave Gandy - https://fontawesome.com/v4.7.0/). It uses the icon_font_to_png package to generate on-fly images.

Documentation

See the wiki pages.

Usage

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

--filter pandoc-latex-tip

Installation

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. Either python 2.7 or 3.x will do.

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 Font-Awesome icons collection add the --force flag

pip install --upgrade --force 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pandoc-latex-tip-1.3.1.tar.gz (7.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page