summaryrefslogtreecommitdiff
path: root/docs/src/index.txt
blob: 33874d1ca34b28f68bcab622d18c5db64f1e9172 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
.. -*- 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>`_

- 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