Syntax highlighting¶

Pygments does syntax highlighting.

What lexers are available? Find the answer with the list command below and use that name in the .. code-block:: LANGUAGE NAME directive.

In Sphinx the Python pygments package is used for syntax highlighting in code blocks.

Pygments is not in charge of highlighting inline code. Inline code doesn't have syntax highlighting. Instead, it may have a specific style dependent on type (textrole) and our css.

Show help:

dockrun_t3rd bashcmd "pygmentize -h"

Show package version:

➜  ~ dockrun_t3rd bashcmd "pygmentize -V"
Pygments version 2.4.2, (c) 2006-2019 by Georg Brandl.

Final exit status: 0 (completed)

➜  ~

Show lexers:

dockrun_t3rd  bashcmd  "pygmentize -L lexers"

TypoScript lexer available?

➜  ~ dockrun_t3rd  bashcmd  "pygmentize -L lexers | grep -i typoscript"

* typoscript:
    TypoScript (filenames *.ts, *.txt)

➜  ~

List more: The -L option lists lexers, formatters, styles or filters - set which to the thing you want to list (for example "styles"), or omit it to list everything:

dockrun_t3rd  bashcmd  "pygmentize -L lexers"
dockrun_t3rd  bashcmd  "pygmentize -L formatters"
dockrun_t3rd  bashcmd  "pygmentize -L styles"
dockrun_t3rd  bashcmd  "pygmentize -L filters"
dockrun_t3rd  bashcmd  "pygmentize -L"

Example: Bash lexer?¶

What's the name of the Bash lexer?

➜  ~ dockrun_t3rd bashcmd  pygmentize -L lexers | grep -i bash
* bash, sh, ksh, zsh, shell:
    Bash (filenames *.sh, *.ksh, *.bash, *.ebuild, *.eclass, *.exheres-0, *.exlib, *.zsh, .bashrc, bashrc, .bash_*, bash_*, zshrc, .zshrc, PKGBUILD)
    Bash Session (filenames *.sh-session, *.shell-session)

➜  ~

This means that bash, sh, ksh, zsh, shell are all synonyms for the same lexer. So shell may be a good and self-explaining choice.