Generates markdown reference documentation for jsii modules.
You can use this as a command line tool or as a library if you need more control.
$ jsii-docgenWill produce a file called API.md with the api reference for this module.
As a library:
import { Documentation, Language } from 'jsii-docgen';
const docs = await Documentation.forProject('.');
const markdown = await docs.toMarkdown({ language: Language.TYPESCRIPT }).render(); // returns a markdown string
const json = await docs.toJson({ language: Language.TYPESCRIPT }).render(); // returns a JSON objectCurreently jsii-docgen supports generating documentation in the following languages:
- TypeScript (
typescript) - Python (
python) - Java (
java) - C# (
csharpordotnet)
All contributions are welcome, just raise an issue or submit a PR. Add a test, update readme. Do the right thing.