
Security News
Deno 2.4 Brings Back deno bundle, Improves Dependency Management and Observability
Deno 2.4 brings back bundling, improves dependency updates and telemetry, and makes the runtime more practical for real-world JavaScript projects.
ts-docs-gen
Advanced tools
Readme is WIP.
Generates documentation from TypeScript files.
npm install ts-docs-gen -g
ts-docs-gen -h
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
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. |
FAQs
Generating documentation for TypeScript code
The npm package ts-docs-gen receives a total of 27 weekly downloads. As such, ts-docs-gen popularity was classified as not popular.
We found that ts-docs-gen demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.4 brings back bundling, improves dependency updates and telemetry, and makes the runtime more practical for real-world JavaScript projects.
Security News
CVEForecast.org uses machine learning to project a record-breaking surge in vulnerability disclosures in 2025.
Security News
Browserslist-rs now uses static data to reduce binary size by over 1MB, improving memory use and performance for Rust-based frontend tools.