A "cheating" tool that generates brief API references for TypeScript libraries with links to source code.
npm install docheat
Docheat is a "cheating" tool for libraries written in TypeScript, it generates
API references inside a markdown file with brief descriptions and links to
source code, i.e., cheating.
This tool is developed for villa, a set
of promise utilities for async-await-ready environment. And currently it
supports ONLY exported functions, please check out the issue list to
see what might be coming next.
Please understand it is NOT meant to generate detailed and well-organized
documentations.
``sh`
yarn global add docheat
Note: to understand the example, please read in the order suggested by step
numbers.
> 1. A docheat entry list starts with marker comment below:
>
> 3. And the following content is generated using docheat under
> current project folder with command docheat demo/tsconfig.json:
#### [[+]](https://github.com/vilic/docheat/blob/v0.1.8/demo/bar.ts#L4) bar(a: string, b: number): Promise
A useless function for demonstration.
#### [[+]](https://github.com/vilic/docheat/blob/v0.1.8/demo/foo.ts#L4) foo(a: string): Promise+2
Another useless function with overloads for demonstration.
##### Overloads:
- foo(b: number): Date
-
> 2. And ends with marker comment below:
>
- -t, --target: Glob patterns of target markdown files, defaults to
README,README.*.4`.
- -l, --level: Heading level of generated entries, defaults to
- -b, --base-url: Base url of source code links
MIT License.