Welcome to Pygments

===================

This is the source of Pygments. It is a **generic syntax highlighter** written

in Python that supports over 300 languages and text formats, for use in code

hosting, forums, wikis or other applications that need to prettify source code.

Installing

----------

... works as usual, use ``pip install Pygments`` to get published versions,

or ``python setup.py install`` to install from a checkout.

Documentation

-------------

... can be found online at http://pygments.org/ or created with Sphinx by ::

cd doc

make html

Development

-----------

... takes place on `GitHub <https://github.com/pygments/pygments>`_, where the

Git repository, tickets and pull requests can be viewed.

Continuous testing runs on GitHub workflows:

.. image:: https://github.com/pygments/pygments/workflows/Pygments/badge.svg

:target: https://github.com/pygments/pygments/actions?query=workflow%3APygments

The authors

-----------

Pygments is maintained by **Georg Brandl**, e-mail address *georg*\ *@*\ *python.org*

and **Matthäus Chajdas**.

Many lexers and fixes have been contributed by **Armin Ronacher**, the rest of

the `Pocoo <http://dev.pocoo.org/>`_ team and **Tim Hatch**.

The code is distributed under the BSD 2-clause license. Contributors making pull

requests must agree that they are able and willing to put their contributions

under that license.