Closed kaustavdm closed 2 years ago
All things docs.
Relevant directories:
./docs/
./docs/public/
./docs/public/api/
typedoc
./docs/dist/
npm run build:docs
Relevant commands:
npm run docs:dev
Fixes #46.
All things docs.
Relevant directories:
./docs/
— All markdown files under this directory are used to generate docs./docs/public/
— Any file present here is copied by vuepress to the root of the destination directory./docs/public/api/
— Output directory fortypedoc
./docs/dist/
— Destination directory for Vuepress, when runningnpm run build:docs
Relevant commands:
npm run docs:dev
— Run local dev server for vuepress docsnpm run build:docs
— Builds typedoc and then vuepress, with vuepress taking typedoc outputFixes #46.