.. -*- mode: rst -*-

========
Overview
========

Welcome to the Pygments documentation.

- Starting with Pygments

  - `Installation <installation.txt>`_

  - `Quickstart <quickstart.txt>`_

  - `Command line interface <cmdline.txt>`_

- Essential to know

  - `Builtin lexers <lexers.txt>`_

  - `Builtin formatters <formatters.txt>`_

  - `Styles <styles.txt>`_

- API and more

  - `API documentation <api.txt>`_

  - `Builtin Tokens <tokens.txt>`_

- Hacking for Pygments

  - `Write your own lexer <lexerdevelopment.txt>`_

  - `Write your own formatter <formatterdev.txt>`_

  - `Register Plugins <plugins.txt>`_

- Hints and Tricks

  - `Using Pygments in ReST documents <rstdirective.txt>`_


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

If you find bugs or have suggestions for the documentation, please
look `here`_ for info on how to contact the team.

You can download an offline version of this documentation from the
`download page`_.

.. _here: http://pygments.pocoo.org/contribute/
.. _download page: http://pygments.pocoo.org/download/