muzimuzhi/minted

minted is a LaTeX package that provides syntax highlighting using the Pygments library. Highlighted source code can be customized using fancyvrb.

minted — highlighted source code for LaTeX

Overview

minted is a LaTeX package that facilitates expressive syntax highlighting using the Pygments library. The package also provides options to customize the highlighted source code output using fancyvrb.

For instance, this code:

\begin{minted}[mathescape,
               linenos,
               numbersep=5pt,
               gobble=2,
               frame=lines,
               framesep=2mm]{csharp}
string title = "This is a Unicode π in the sky"
/*
Defined as $\pi=\lim_{n\to\infty}\frac{P_n}{d}$ where $P$ is the perimeter
of an $n$-sided regular polygon circumscribing a
circle of diameter $d$.
*/
const double pi = 3.1415926535
\end{minted}

will produce the following rendering:

See the documentation for examples and installation instructions.

Notice that minted requires that LaTeX run with the -shell-escape flag. This has security implications; it allows LaTeX to run external programs. -shell-escape should only be used with documents that you trust.

Availability

minted is distributed with both TeX Live and MiKTeX. It is also available from CTAN. In any case, Python and Pygments need to be installed separately.

License

This work may be distributed and/or modified under the conditions of the LaTeX Project Public License (LPPL), version 1.3 or later.

Additionally, the project may be distributed under the terms of the 3-Clause ("New") BSD license.

Please use the project's GitHub site at https://github.com/gpoore/minted for suggestions, feature requests, and bug reports.