CodeDocs service

Documentation generator service

The codedocs service will download and render the Sass and JSDoc documentation for any module listed in the Origami Registry. If your module is in the registry, and documented using SassDoc or JSDoc comments, you can get documentation without installing or running any tools yourself.

Usage

/v1/type/module@version

To view the SassDoc documentation for o-grid at version 3.0.0-beta.4, load /v1/sassdoc/o-grid@3.0.0-beta.4

To view the JSDoc documentation for o-tracking at version 1.0.14, load /v1/jsdoc/o-tracking@1.0.14

If your project has a .sassdocrc file, the SassDoc service will render the page using the config defined there. The service will ignore the theme configuration key and always serve the documentation using its own theme.