API Docs
compodoc used to generate API docs

Generate

1
# generate docs
2
npx compodoc -p tsconfig.json -d dist/docs
3
# serve docs
4
npx compodoc -s -d dist/docs
Copied!

Publish

Create gh-pages branch (one time)

1
git checkout --orphan gh-pages
2
# preview files to be deleted
3
git rm -rf --dry-run .
4
# actually delete the files
5
git rm -rf .
6
git push --set-upstream origin gh-pages
Copied!
Publish API docs GitHub's GH-Pages
1
git subtree push --prefix dist/docs origin gh-pages
Copied!
Last modified 9mo ago