Docworks
A tool for parsing documentation and transforming it to a JSON as a model.
Getting started
yarn
(using yarn workspaces)
Commands
local
- generates the JSON model from the JSDoc to a local directoryecp
- generates the JSON model from the JSDoc, compares with previous model, commits and pushes the changestern
- builds a tern model from the generated JSON modeldts
- builds typescript decleartion files from the generated JSON modelvalidate
Tests
- Use
yarn test
to run the tests in all packages
Publishing
- Use
yarn release
to create a release commit and git tag. - Use
git push --follow-tags
so that CI can pick up the new tag and trigger publishing to npm (CI will runyarn ci:publish
)