Jsii-docgen NPM

jsii-docgen

Generates markdown reference documentation for jsii modules.

Usage

You can use this as a command line tool or as a library if you need more control.

$ jsii-docgen

Will 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 object

Curreently jsii-docgen supports generating documentation in the following languages:

TypeScript (typescript)
Python (python)
Java (java)
C# (csharp)
Go (go)

CLI Options

Option	Required	Description
`--output`, `-o`	optional	Output filename (defaults to API.md if format is markdown, and API.json if format is JSON). `jsii-docgen -o ./docs/API.md`
`--format`, `-f`	optional	Output format. Can be `markdown` or `json`. `jsii-docgen -f json`
`--language`, `-l`	optional	Language to generate documentation for. Can be `typescript`, `python`, `java`, `csharp` or `go`. `jsii-docgen -l typescript`
`--package`, `-p`	optional	The name@version of an NPM package to document. `jsii-docgen -p my-package`
`--readme`, `-r`	optional	Generate docs for user specified README.md. `jsii-docgen -r`
`--submodule`, `-s`	optional	Generate docs for a specific submodule or "root". `jsii-docgen -s my-submodule`
`--split-by-submodule`	optional	Generate a separate file for each submodule. `jsii-docgen --split-by-submodule`

Contributions

All contributions are welcome, just raise an issue or submit a PR. Add a test, update readme. Do the right thing.

License

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

7 months ago

7 months ago

7 months ago

8 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

11 months ago

12 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

10 months ago

11 months ago

10 months ago

11 months ago

11 months ago

10 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

10 months ago

10 months ago

10 months ago

12 months ago