1.0.3 • Published 3 years ago
@ridesz/usual-documentation-generator v1.0.3
@ridesz/usual-documentation-generator
The typical documentation generator config I use for my TypeScript projects.
How to use
package.json
setup
Just please add this scripts
tag part to your package.json
file too:
{
"doc": "npx @ridesz/usual-documentation-generator",
}
GitLab CI config
Please add the necessary parts to your .gitlab-ci.yml
file:
image: node:lts
stages:
- documentation
documentation:
stage: documentation
script:
- npm install
- npm run doc
artifacts:
paths:
- reports/docs
expire_in: 1 week
This would use the latest node image and do the documentation generation as part of the documentation
stage.
Running manually
If you would like to run the documentation generation manually then you can use the following command:
npm run doc
Some implementation details
The documentation is generated into the reports/docs
folder.