Both the website and the PDF guide are generated from the Literate CoffeeScript (runnable Markdown) files
in this directory. The examples are actually run when generating the PDF in order to show the results inline.
generate.coffee file in this directory is actually quite short. It parses the markdown files into a
tree structure using markdown-js, syntax highlights the code
examples using codemirror, compiles and runs the code examples and puts the results
inline, and generates the PDF using PDFKit. You can read the generator script source code to get a feeling for
how you might do something slightly more complex than the guide itself shows.
The markdown syntax used is pretty much standard, with a couple tweaks.
Code example output is references using the image notation, using the alt text as the example number starting from zero in the current file, and the title as the example output height. E.g.
Page breaks are added before
h2s, unless there are two in a row.
h3is treated the same as
h2but can be used to avoid this in the case you need multiple
h2s on the same page.
The horizontal rule syntax (
* * *) denotes an explicit page break