A fork of gcanti/docs-ts.
-
npm i docs-ts-extra -D -
Run
npx docs-ts-extraA 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. |