tikz.dev - HTML version of the PGF-TikZ documentation

This is a browsable HTML version of the package documentation for PGF/TikZ, whose PDF version is 1300+ pages long. It is built using the incredibly powerful lwarp package by Brian Dunn.

Feedback

For feedback, bug reports, and feature requests, open an issue in the tikz.dev issue repository.

Usage

The documentation is produced using the following steps.

1. Separately compile examples that use animation with dvisvgm in standalone files, produced by a python script.
2. Compile documentation using lwarp, which also generates tikz pictures in SVG format.
3. Postprocess the resulting HTML using a python script built with BeautifulSoup for HTML parsing:
   • Highlight the current page in the side table of contents
   • Build a table of contents for the current page
   • Add visible HTML anchor links ¶
   • Add clipboard buttons
   • Annotate <img> tags with weight and height by parsing the SVG files
   • Add header and footer
4. Prettify the HTML files with prettier.
5. Reduce SVG file sizes with svgo.

To get lwarp to compile, some fixing of the macros for pretty printing was necessary and edits throughout the documentation. The end product is combined with some css and a sprinkling of javascript. Search uses Algolia's DocSearch.

Project started December 2021 by Dominik Peters.