README.md
1# Vulkan Asciidoc Configuration Files
2
3## Macros
4
5The macros in `vulkan-macros.rb` and `vulkan-macros/extension.rb` are
6described in the "Vulkan Documentation and Extensions: Procedures and
7Conventions" document (see the [styleguide](../styleguide.txt)).
8
9## Support for Math
10
11Asciidoctor is customized to insert KaTeX `<script>` tags from
12`math.js` for HTML5, and properly pass through math which has
13`\begin{}\/end{}` delimiters instead of $$\[\]\(\).
14
15For PDF builds, asciidoctor-mathematical is used to generate
16
17`math-docbook.conf` is heavily conditionalized depending on whether the
18final output format (which should be described in the a2x-format variable)
19is `pdf` or not, since Docbook passes through math differently to dblatex
20vs. the XHTML stylesheets. This could be simplified now that we're only
21using Docbook for PDFs.
22
23## Stylesheets
24
25`khronos.css` is the stylesheet used for HTML output.
26