Vulkan-Docs/config
Petr Kraus 7a2c0f1637 Fix links in PDF build (#879) 2018-12-16 20:13:47 -08:00
..
extension-highlighter Change log for April 15, 2018 Vulkan 1.1.73 spec update: 2018-04-15 03:32:07 -07:00
katex_replace Update pattern used to remove MathJaX script injected by asciidoctor 2018-11-04 02:05:08 -08:00
themes Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
vu-to-json Change log for July 7, 2018 Vulkan 1.1.80 spec update: 2018-07-07 02:21:56 -07:00
vulkan-macros Change log for October 7, 2018 Vulkan 1.1.87 spec update: 2018-10-07 06:10:21 -07:00
.gitignore Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
README.md Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
asciidoctor-mathematical-ext.rb Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
attribs.txt Fixed typos 2018-11-16 19:42:02 +01:00
extension-highlighter.rb Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
katex_replace.rb Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
khronos.css Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
makeSubmit.py Change log for October 7, 2018 Vulkan 1.1.87 spec update: 2018-10-07 06:10:21 -07:00
mathtest.txt Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
optimize-pdf Fix links in PDF build (#879) 2018-12-16 20:13:47 -08:00
tilde_open_block.rb Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
vu-to-json.rb Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
vulkan-macros.rb Change log for October 7, 2018 Vulkan 1.1.87 spec update: 2018-10-07 06:10:21 -07:00

README.md

Vulkan Asciidoc Configuration Files

Macros

The macros in vulkan-macros.rb and vulkan-macros/extension.rb are described in the "Vulkan Documentation and Extensions: Procedures and Conventions" document (see the styleguide).

Support for Math

Asciidoctor is customized to insert KaTeX <script> tags from math.js for HTML5, and properly pass through math which has \begin{}\/end{} delimiters instead of [].

For PDF builds, asciidoctor-mathematical is used to generate

math-docbook.conf is heavily conditionalized depending on whether the final output format (which should be described in the a2x-format variable) is pdf or not, since Docbook passes through math differently to dblatex vs. the XHTML stylesheets. This could be simplified now that we're only using Docbook for PDFs.

Stylesheets

khronos.css is the stylesheet used for HTML output.