| Age | Commit message (Collapse) | Author |
|---|
|
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>
|
|
- Reduced margins
- Better visual separation of method descriptions
- Improved display of argument and return value attributes
- Improved display of object and array type descriptions
- Shortened absolute module name paths
The local JavaScript fixups are a stop-gap measure for now, in the long
it likely makes more sense to fork the used JSDoc theme to apply the
desired changes directly to the markup.
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
|
|
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
|
|
- 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>
|
|
Pipe symbols inside table definitions must be escaped.
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
|
|
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
|
|
- 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>
|
|
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>
|
