summaryrefslogtreecommitdiffhomepage
path: root/jsdoc
AgeCommit message (Collapse)Author
2024-04-24jsdoc: disable default module titlesJo-Philipp Wich
Our module documentation provides its own titles, so suppress generation of default titles. Signed-off-by: Jo-Philipp Wich <jo@mein.io>
2023-10-19jsdoc: switch to own custom themeJo-Philipp Wich
Switch to a custom fork of the clean jsdoc theme to address a number of quirks and to directly incorporate CSS and markup changes. Signed-off-by: Jo-Philipp Wich <jo@mein.io>
2023-10-17jsdoc: properly handle indented documentation blocksJo-Philipp Wich
Fix the jsdoc C transpiler plugin to properly detect the start of indented multi line comment blocks. Signed-off-by: Jo-Philipp Wich <jo@mein.io>
2023-07-13docs: further reworkJo-Philipp Wich
- Split README.md into several tutorial pages - Expand all menu panes - Hide class menu entries - Add usage information Signed-off-by: Jo-Philipp Wich <jo@mein.io>
2023-07-13docs: various improvementsJo-Philipp Wich
- Switch JSDoc theme to "clean-jsdoc-theme" - Add some custom CSS and JS tweaks to the theme - Use a condensed README.md for the toplevel directory - Include a longer README.md in the documentation portal - Tweak JSDoc annotations for better output results - Register `ucode.mein.io` CNAME Signed-off-by: Jo-Philipp Wich <jo@mein.io>
2023-07-12docs: add initial JSDoc infrastructureJo-Philipp Wich
Introduce the infrastructure for building ucode module documentation using JSDoc annotations. To build the documentation, run `npm install` followed by `npm run doc`. Signed-off-by: Jo-Philipp Wich <jo@mein.io>