Y
Y
YETI
1.0.0
Search…
⌃K
Links

API Docs

compodoc used to generate API docs

Generate

# generate docs
npx compodoc -p tsconfig.json -d dist/docs
# serve docs
npx compodoc -s -d dist/docs

Publish

Create gh-pages branch (one time)

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