summaryrefslogtreecommitdiff
path: root/docs/src/index.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src/index.txt')
-rw-r--r--docs/src/index.txt51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/src/index.txt b/docs/src/index.txt
new file mode 100644
index 00000000..33874d1c
--- /dev/null
+++ b/docs/src/index.txt
@@ -0,0 +1,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