docs-ts-extra
v0.7.1
Published
Documentation tool for TypeScript packages
Downloads
4
Readme
docs-ts-extra
A fork of gcanti/docs-ts.
Setup and usage
npm i docs-ts-extra -D
Run
npx docs-ts-extra
Configuration
A docsts
object on package.json
with the following properties (all optional):
| Key | Type | Optional | Default | Description |
| --------- | --------- | -------- | ------- | --------------------------------------------------------------------------------- |
| strict
| boolean
| Yes | true
| Strict mode requires every module and export to have a JSDoc with a @since
tag. |
| rootDir
| string
| Yes | src
| Source code directory to extract documentation from. |
| outDir
| string
| Yes | docs
| Output directory to write Markdown docs to. |