The documentation is written in AsciiDoc (.adoc). You can view it in several ways:

• View in IDE
• Convert to HTML
• Convert to PDF

Install an AsciiDoc plugin for your IDE:

• VS Code: AsciiDoc by asciidoctor
• IntelliJ IDEA: AsciiDoc Plugin

After installing the plugin, open any .adoc file in cairo/docs/reference.

macOS:

brew install asciidoctor

Ubuntu:

sudo apt-get install asciidoctor

Tip: run the commands from cairo/docs/reference

Convert a single file:

asciidoctor src/Summary.adoc

Convert all .adoc files:

asciidoctor src/*.adoc

HTML files will be created in the same directory as the source files.

Note: asciidoctor-pdf is not installed automatically with asciidoctor.

macOS:

brew install asciidoctor-pdf

Ubuntu: (asciidoctor-pdf is not always available in apt, so RubyGems is used)

sudo apt-get install ruby ruby-dev
sudo gem install asciidoctor-pdf

Tip: run the commands from cairo/docs/reference

Convert a single file:

asciidoctor-pdf src/Summary.adoc

Convert all .adoc files:

asciidoctor-pdf src/*.adoc

PDF files will be created next to the source .adoc files.