-
Notifications
You must be signed in to change notification settings - Fork 796
writingDemos
Demos in PMTK3 are automatically published to html using the publishDemos() function. To ensure that these demos look nice, please format the comments as follows:
Every demo should have a title. This will appear in two places, the list of demos by chapter, and at the top of the demo itself.
* The title must be a single line, and the very first line of the file, above even the function header. * The title line must begin with two % signs followed by a single space, as in {{{%% Demo Title Here}}}. * Additional comments that pertain to the whole demo should immediately follow the title without any blank lines and with each line beginning with a single % sign followed by a space. * This comment block, even if empty, must end with two %% signs before the first line of Matlab code.
Break the demo into logical sections using two %% signs. The comment text on this line is used as the section title and appears in the demos 'table' of contents.
Once you're finished writing your demo, preview what the published version will look like using the previewPublish() function.