A pandoc filter for adding tip in LaTeX
Project description
# pandoc-latex-tip [](https://travis-ci.org/chdemko/pandoc-latex-tip/branches) [](https://coveralls.io/github/chdemko/pandoc-latex-tip?branch=2.1.4) [](https://codeclimate.com/github/chdemko/pandoc-latex-tip/) [](https://codebeat.co/projects/github-com-chdemko-pandoc-latex-tip-develop/) [](https://www.codacy.com/app/chdemko/pandoc-latex-tip) [](https://www.codefactor.io/repository/github/chdemko/pandoc-latex-tip) [](https://scrutinizer-ci.com/g/chdemko/pandoc-latex-tip/) [](https://pypi.org/project/pandoc-latex-tip/) [](https://pypi.org/project/pandoc-latex-tip/) [](https://raw.githubusercontent.com/chdemko/pandoc-latex-tip/2.1.4/LICENSE) [](https://pypi.org/project/pandoc-latex-tip/) [](https://pepy.tech/project/pandoc-latex-tip) [](https://libraries.io/pypi/pandoc-latex-tip) [](https://pypi.org/project/pandoc-latex-tip/) [](http://pandoc-latex-tip.readthedocs.io/en/2.1.4/) [](https://pypi.org/project/black/)
license icon by [Daniel Bruce](https://www.iconfinder.com/icons/216659/license_icon), format icon by [Picol](https://www.iconfinder.com/icons/103509/document_text_icon), status icon by [Just Icon](https://www.iconfinder.com/icons/2672768/app_battery_essential_object_status_ui_ux_icon), code style icon by [Google Material Design icons](https://www.iconfinder.com/icons/352148/style_icon)
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.
[pandoc]: http://pandoc.org/
Documentation
See the [Read the docs pages](http://pandoc-latex-tip.readthedocs.io/en/2.1.4/).
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](https://pillow.readthedocs.io/en/5.2.x/installation.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
apt-get build-dep python-imaging apt-get install libjpeg8 libjpeg62-dev libfreetype6 libfreetype6-dev
[python 3.6]: 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
](https://travis-ci.org/chdemko/pandoc-latex-tip/branches){kind=link}
](https://coveralls.io/github/chdemko/pandoc-latex-tip){kind=link}
](https://codeclimate.com/github/chdemko/pandoc-latex-tip/){kind=link}
](https://www.codacy.com/app/chdemko/pandoc-latex-tip){kind=link}
](https://scrutinizer-ci.com/g/chdemko/pandoc-latex-tip/){kind=link}
](https://pypi.org/project/pandoc-latex-tip/){kind=link}
](https://pypi.org/project/pandoc-latex-tip/){kind=link}
](https://raw.githubusercontent.com/chdemko/pandoc-latex-tip/2.1.4/LICENSE){kind=link}
](https://pypi.org/project/pandoc-latex-tip/){kind=link}
](https://libraries.io/pypi/pandoc-latex-tip){kind=link}
](https://pypi.org/project/pandoc-latex-tip/){kind=link}
](http://pandoc-latex-tip.readthedocs.io/en/2.1.4/){kind=link}
](https://pypi.org/project/black/){kind=link}