Giter Club home page Giter Club logo

pandoc-latex-tip's Introduction

pandoc-latex-tip

Build Status Coveralls Code Climate Code Beat Codacy CodeFactor Scrutinizer PyPI version PyPI format License Python version Downloads Source Rank Development Status Docs Code style: black

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.

pandoc-latex-tip's People

Contributors

chdemko avatar daamien avatar hashiprobr avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.