@tstelzer/yatsdg
v0.1.0-alpha-1.3
Published
Generates documentation from TypeScript source files, markdown files and more.
Downloads
1
Readme
Yet Another TypeScript Documentation Generator (yatsdg)
This package is still in alpha stage, experimental, incomplete and without documentation. You probably should not use it at this stage.
Quickstart
- Run
npm i -D @tstelzer/yatsdg. - Add to your
scriptsinpackage.json:"doc": "yatsdg". - Run
npm run doc.
Known Issues
- Module resolution for any paths that aren't ancestors of the root dir are
fully resolved. For example, with
/rootand/aside, the path/root/a.tsis resolved asa.tsand/aside/b.tsis resolved as/aside/b.ts.
