Vulkan-Docs/doc/specs/vulkan/config
Petr Kraus 3c84f8fe4d Adding chapter name into the pdf page footer 2017-10-13 16:13:55 +02:00
..
extension-highlighter Change log for September 5, 2017 Vulkan 1.0.60 spec update: 2017-09-04 03:06:55 -07:00
katex_replace Change log for February 10, 2017 Vulkan 1.0.40 spec update: 2017-02-10 20:37:39 -08:00
themes Adding chapter name into the pdf page footer 2017-10-13 16:13:55 +02:00
vu-to-json Change log for June 4, 2017 Vulkan 1.0.51 spec update: 2017-06-04 20:48:43 -07:00
vulkan-macros Change log for March 17, 2017 Vulkan 1.0.44 spec update: 2017-03-17 22:53:58 -07:00
.gitignore Change log for September 5, 2017 Vulkan 1.0.60 spec update: 2017-09-04 03:06:55 -07:00
README.md Change log for February 10, 2017 Vulkan 1.0.40 spec update: 2017-02-10 20:37:39 -08:00
asciidoctor-mathematical-ext.rb Change log for June 24, 2017 Vulkan 1.0.53 spec update: 2017-06-26 19:32:10 -07:00
attribs.txt Change log for June 24, 2017 Vulkan 1.0.53 spec update: 2017-06-26 19:32:10 -07:00
extension-highlighter.rb Change log for September 5, 2017 Vulkan 1.0.60 spec update: 2017-09-04 03:06:55 -07:00
katex_replace.rb Change log for February 10, 2017 Vulkan 1.0.40 spec update: 2017-02-10 20:37:39 -08:00
makeSubmit.py Change log for September 5, 2017 Vulkan 1.0.60 spec update: 2017-09-04 03:06:55 -07:00
mathtest.txt Change log for February 10, 2017 Vulkan 1.0.40 spec update: 2017-02-10 20:37:39 -08:00
optimize-pdf Change log for February 27, 2017 Vulkan 1.0.42 spec update: 2017-02-26 22:54:26 -08:00
tilde_open_block.rb Change log for September 5, 2017 Vulkan 1.0.60 spec update: 2017-09-04 03:06:55 -07:00
vu-to-json.rb Change log for May 12, 2017 Vulkan 1.0.49 spec update: 2017-05-12 01:37:16 -07:00
vulkan-macros.rb Change log for March 17, 2017 Vulkan 1.0.44 spec update: 2017-03-17 22:53:58 -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.