Generating documentation for TypeScript code
Last updated 3 years ago by simplrjs-admin .
Original npm · Tarball · package.json
$ cnpm install ts-docs-gen 
SYNC missed versions from official npm registry.


Readme is WIP.

Generates documentation from TypeScript files.

Get started

npm install ts-docs-gen -g

CLI usage

ts-docs-gen -h


Without config

If you want to use ts-docs-gen without config file, entryFile flag is required.

ts-docs-gen --entryFile ./src/index.ts

Multiple entry files:

ts-docs-gen --entryFile ./src/index.ts --entryFile ./src/internal.ts
# Or
ts-docs-gen --entryFile ./src/index.ts ./src/internal.ts

With config

ts-docs-gen --config ./docs-gen.json


JSON config properties and CLI flags.

Property CLI Flag Required Type Default Description
--config optional string Relative path to config json file.
entryFile --entryFile required string[] TypeScript project entry files.
project --project, -p optional string cwd Full path to TypeScript project directory.
output --output, -o optional string ./docs/api/ Documentation output directory.
plugin --plugin optional string[] Package name or path to plugin.
exclude --exclude optional string[] File locations that should not be included generated documentation.
externalPackage --externalPackage optional string[] External package names to include in extracted data.
excludePrivateApi --excludePrivateApi optional boolean true Excludes api items that has access modifier set to "private" or JSDoc tag "@private".
verbosity --verbosity optional "None", "Critical", "Error", "Warning", "Information", "Debug", "Trace" "Information" Verbosity of output.
dryRun --dryRun optional boolean Generates markdown files but not writes them. Outputs generated data in Debug log level.

Current Tags

  • 0.2.0                                ...           latest (3 years ago)

3 Versions

  • 0.2.0                                ...           3 years ago
  • 0.1.0                                ...           3 years ago
  • 0.0.0-alpha                                ...           3 years ago
Today 0
This Week 0
This Month 2
Last Day 0
Last Week 0
Last Month 5
Dependencies (8)
Dev Dependencies (8)
Dependents (0)

Copyright 2014 - 2016 © taobao.org |