Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chdemko/pandoc-latex-color
A pandoc filter for applying different color on specific elements
https://github.com/chdemko/pandoc-latex-color
color filter latex pandoc pypi python x11
Last synced: 24 days ago
JSON representation
A pandoc filter for applying different color on specific elements
- Host: GitHub
- URL: https://github.com/chdemko/pandoc-latex-color
- Owner: chdemko
- License: bsd-3-clause
- Created: 2018-03-19T14:03:32.000Z (almost 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-22T15:04:41.000Z (3 months ago)
- Last Synced: 2024-12-06T07:10:31.785Z (about 1 month ago)
- Topics: color, filter, latex, pandoc, pypi, python, x11
- Language: Python
- Homepage: https://pandoc-latex-color.readthedocs.io/
- Size: 308 KB
- Stars: 14
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Installation
============
[](https://github.com/chdemko/pandoc-latex-color/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-color?branch=develop)
[](https://scrutinizer-ci.com/g/chdemko/pandoc-latex-color/)
[](https://codeclimate.com/github/chdemko/pandoc-latex-color/)
[](https://www.codefactor.io/repository/github/chdemko/pandoc-latex-color)
[](https://app.codacy.com/gh/chdemko/pandoc-latex-color/dashboard)
[](https://pypi.org/project/pandoc-latex-color/)
[](https://pypi.org/project/pandoc-latex-color/)
[](https://raw.githubusercontent.com/chdemko/pandoc-latex-color/develop/LICENSE)
[](https://pepy.tech/project/pandoc-latex-color)
[](https://pypi.org/project/pandoc-latex-color/)
[](https://pypi.org/project/pandoc-latex-color/)
[](https://pandoc.org/)
[](https://github.com/chdemko/pandoc-latex-color/releases)
[](https://github.com/chdemko/pandoc-latex-color/commit/develop/)
[](http://pandoc-latex-color.readthedocs.io/en/latest/)
[](http://pandoc-latex-color.readthedocs.io/en/latest/)
[](https://libraries.io/pypi/pandoc-latex-color)
[](http://pandoc-latex-color.readthedocs.io/en/latest/)
*pandoc-latex-color* is a [pandoc] filter for setting the color to `Span`
that have speficied classes or `latex-color` attribute.
[pandoc]: http://pandoc.org/
Instructions
------------
*pandoc-latex-color* 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-color* using the bash command
~~~shell-session
$ pipx install pandoc-latex-color
~~~
To upgrade to the most recent release, use
~~~shell-session
$ pipx upgrade pandoc-latex-color
~~~
`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/).
It uses the *xcolor* LaTeX package to handle correctly colors in spans
and the *soulutf8* package for highlighing the text.
[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-color*,
please feel welcome to [file an issue] on github so that we can help.
[file an issue]: https://github.com/chdemko/pandoc-latex-color/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.
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.