Documentation

Overview

Important: the docs on this page always describe the development version of Pygments. If you want to view the docs for a specific released version, download the tarball from the Cheese Shop.

Welcome to the Pygments documentation.

• Starting with Pygments
  • Installation
  • Introduction and Quickstart
  • Command line interface
• Builtin components
  • Lexers
  • Formatters
  • Filters
  • Styles
• Reference
  • Unicode and encodings
  • Builtin tokens
  • API documentation
• Hacking for Pygments
  • Write your own lexer
  • Write your own formatter
  • Write your own filter
  • Register plugins
• Hints and Tricks
  • Using Pygments in ReST documents
  • Using Pygments with MoinMoin
  • Using Pygments in other contexts
• About Pygments
  • Changelog
  • Authors

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.