Installation
============
[](https://github.com/chdemko/pandoc-latex-tip/actions/workflows/python-package.yml)
[](https://github.com/pypa/hatch)
[](https://github.com/pre-commit/pre-commit)
[](https://pypi.org/project/black/)
[](https://coveralls.io/github/chdemko/pandoc-latex-tip?branch=develop)
[](https://scrutinizer-ci.com/g/chdemko/pandoc-latex-tip/)
[](https://codeclimate.com/github/chdemko/pandoc-latex-tip/)
[](https://www.codefactor.io/repository/github/chdemko/pandoc-latex-tip)
[](https://app.codacy.com/gh/chdemko/pandoc-latex-tip/dashboard)
[](https://pypi.org/project/pandoc-latex-tip/)
[](https://pypi.org/project/pandoc-latex-tip/)
[](https://raw.githubusercontent.com/chdemko/pandoc-latex-tip/develop/LICENSE)
[](https://pepy.tech/project/pandoc-latex-tip)
[](https://pypi.org/project/pandoc-numbering/)
[](https://pypi.org/project/pandoc-latex-tip/)
[](https://pandoc.org/)
[](https://github.com/chdemko/pandoc-latex-tip/releases)
[](https://github.com/chdemko/pandoc-latex-tip/commit/develop/)
[](http://pandoc-latex-tip.readthedocs.io/en/latest/)
[](http://pandoc-latex-tip.readthedocs.io/en/latest/)
[](https://libraries.io/pypi/pandoc-latex-tip)
[](http://pandoc-latex-tip.readthedocs.io/en/latest/)
*pandoc-latex-tip*, designed to be used in conjuction with
[*pandoc-latex-admonition*](https://github.com/chdemko/pandoc-latex-admonition),
is a [pandoc] filter for adding icon tooltips in the margin
using popular icon collections.
[pandoc]: http://pandoc.org/
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
~~~shell-session
$ pipx install pandoc-latex-tip
~~~
To upgrade to the most recent release, use
~~~shell-session
$ 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](https://pipx.pypa.io/stable/).
Make sure you have required packages for
[Pillow installation](https://pillow.readthedocs.io/en/stable/installation/index.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
~~~shell-session
$ sudo apt-get install python3-pil
~~~
[python]: 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
Contribute
==========
Instructions
------------
Install `hatch`, then run
~~~shell-session
$ hatch run pip install pre-commit
$ hatch run pre-commit install
~~~
to install `pre-commit` before working on your changes.
Download font files
-------------------
Run
~~~shell-session
$ hatch run python download.py
~~~
to download font files.
Tests
-----
When your changes are ready, run
~~~shell-session
$ 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "pandoc-latex-tip",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.10",
"maintainer_email": "Christophe Demko <chdemko@gmail.com>",
"keywords": "Font-Awesome, filters, icon, latex, pandoc, tip",
"author": null,
"author_email": "Christophe Demko <chdemko@gmail.com>",
"download_url": null,
"platform": null,
"description": "Installation\n============\n\n[](https://github.com/chdemko/pandoc-latex-tip/actions/workflows/python-package.yml)\n[](https://github.com/pypa/hatch)\n[](https://github.com/pre-commit/pre-commit)\n[](https://pypi.org/project/black/)\n[](https://coveralls.io/github/chdemko/pandoc-latex-tip?branch=develop)\n[](https://scrutinizer-ci.com/g/chdemko/pandoc-latex-tip/)\n[](https://codeclimate.com/github/chdemko/pandoc-latex-tip/)\n[](https://www.codefactor.io/repository/github/chdemko/pandoc-latex-tip)\n[](https://app.codacy.com/gh/chdemko/pandoc-latex-tip/dashboard)\n[](https://pypi.org/project/pandoc-latex-tip/)\n[](https://pypi.org/project/pandoc-latex-tip/)\n[](https://raw.githubusercontent.com/chdemko/pandoc-latex-tip/develop/LICENSE)\n[](https://pepy.tech/project/pandoc-latex-tip)\n[](https://pypi.org/project/pandoc-numbering/)\n[](https://pypi.org/project/pandoc-latex-tip/)\n[](https://pandoc.org/)\n[](https://github.com/chdemko/pandoc-latex-tip/releases)\n[](https://github.com/chdemko/pandoc-latex-tip/commit/develop/)\n[](http://pandoc-latex-tip.readthedocs.io/en/latest/)\n[](http://pandoc-latex-tip.readthedocs.io/en/latest/)\n[](https://libraries.io/pypi/pandoc-latex-tip)\n[](http://pandoc-latex-tip.readthedocs.io/en/latest/)\n\n\n\n*pandoc-latex-tip*, designed to be used in conjuction with\n[*pandoc-latex-admonition*](https://github.com/chdemko/pandoc-latex-admonition),\nis a [pandoc] filter for adding icon tooltips in the margin\nusing popular icon collections.\n\n[pandoc]: http://pandoc.org/\n\nInstructions\n------------\n\n*pandoc-latex-tip* requires [python], a programming language that comes\npre-installed on linux and Mac OS X, and which is easily installed\n[on Windows].\n\nInstall *pandoc-latex-tip* using the bash command\n\n~~~shell-session\n$ pipx install pandoc-latex-tip\n~~~\n\nTo upgrade to the most recent release, use\n\n~~~shell-session\n$ pipx upgrade pandoc-latex-tip\n~~~\n\n`pipx` is a script to install and run python applications in isolated\nenvironments from the Python Package Index, [PyPI]. It can be installed\nusing instructions given [here](https://pipx.pypa.io/stable/).\n\nMake sure you have required packages for\n[Pillow installation](https://pillow.readthedocs.io/en/stable/installation/index.html).\nOn linux you have to install some extra libraries\n**before** *pandoc-latex-tip*. On a Debian-based system (including Ubuntu),\nyou can install it as root using\n\n~~~shell-session\n$ sudo apt-get install python3-pil\n~~~\n\n[python]: https://www.python.org\n[on Windows]: https://www.python.org/downloads/windows\n[PyPI]: https://pypi.org\n\n\nGetting Help\n------------\n\nIf you have any difficulties with pandoc-latex-tip, please feel welcome to\n[file an issue] on github so that we can help.\n\n[file an issue]: https://github.com/chdemko/pandoc-latex-tip/issues\n\nContribute\n==========\n\nInstructions\n------------\n\nInstall `hatch`, then run\n\n~~~shell-session\n$ hatch run pip install pre-commit\n$ hatch run pre-commit install\n~~~\n\nto install `pre-commit` before working on your changes.\n\nDownload font files\n-------------------\n\nRun\n\n~~~shell-session\n$ hatch run python download.py\n~~~\n\nto download font files.\n\nTests\n-----\n\nWhen your changes are ready, run\n\n~~~shell-session\n$ hatch test\n$ hatch fmt --check\n$ hatch run lint:check\n$ hatch run docs:build\n$ hatch build -t wheel\n~~~\n\nfor running the tests, checking the style, building the documentation\nand building the wheel.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A pandoc filter for adding icons on specific elements",
"version": "3.2.0.1",
"project_urls": {
"Coverage": "https://coveralls.io/github/chdemko/pandoc-latex-tip",
"Documentation": "https://pandoc-latex-tip.readthedocs.io/",
"Homepage": "https://github.com/chdemko/pandoc-latex-tip",
"Issues": "https://github.com/chdemko/pandoc-latex-tip/issues",
"Repository": "https://github.com/chdemko/pandoc-latex-tip"
},
"split_keywords": [
"font-awesome",
" filters",
" icon",
" latex",
" pandoc",
" tip"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "981c4095f8ff36b4ca023151a29368d678e0da6a28fd6d91fb965907c447161e",
"md5": "0ee59328e23d9f411cf7d61c301feb13",
"sha256": "76aa6a04eedb3974f0c4cf31089c579cde65d66c44fe01f5b64507306c540959"
},
"downloads": -1,
"filename": "pandoc_latex_tip-3.2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ee59328e23d9f411cf7d61c301feb13",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.10",
"size": 360540,
"upload_time": "2024-12-17T13:18:47",
"upload_time_iso_8601": "2024-12-17T13:18:47.166643Z",
"url": "https://files.pythonhosted.org/packages/98/1c/4095f8ff36b4ca023151a29368d678e0da6a28fd6d91fb965907c447161e/pandoc_latex_tip-3.2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 13:18:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chdemko",
"github_project": "pandoc-latex-tip",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pandoc-latex-tip"
}
JSON
