Honkit is used to build static pages from the markdown. The format for multi-language books is used as described in the Honkit documentation.
Install honkit
$ npm install honkit --save-dev
Serve static pages for testing (from docs/):
$ npx honkit serve
Build static pages for production:
$ npx honkit build
When writing plugdata documentation use the Google Developer Documentation Style Guide.
plugdata is always written in lower case, even when it is at the beginning of a sentence.
Names of Pd objects and Pd specific terminology should be left untranslated.
Files to help update screenshots with markup are included which have the screenshot image and any markup graphics (numbers, explanatory text) on different layers. As the UI updates, a screenshot can be replaced using an application like Inkscape.
plugdata_main_interface_markup.svg