Skip to content

gaslamp Documentation

Docs

Build documentation¶

MkDocs site¶

Bash

task docs:serve   # Serve locally with live reload
task docs:build   # Build static site

The .md files under docs/ are used to generate the site.
Documentation settings are configured in mkdocs.yml.

API documentation¶

Bash

task docs:api
# or
npm run docs:api

Generates API docs from TypeDoc comments in src/.
Output is placed in docs/api/.
TypeDoc settings are configured in typedoc.json.

References¶

mkdocs.yml — MkDocs configuration
typedoc.json — TypeDoc configuration
package.json — npm scripts

Release — Release a new version
Naming Guidelines — Documentation naming conventions