0.1.0-alpha-1.3 • Published 5 years ago

@tstelzer/yatsdg v0.1.0-alpha-1.3

Weekly downloads
3
License
MIT
Repository
github
Last release
5 years ago

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 scripts in package.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 /root and /aside, the path /root/a.ts is resolved as a.ts and /aside/b.ts is resolved as /aside/b.ts.