🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

ts-docs-gen

Package Overview
Dependencies
Maintainers
2
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ts-docs-gen

Generating documentation for TypeScript code

0.2.0
latest
Source
npm
Version published
Weekly downloads
147
90.91%
Maintainers
2
Weekly downloads
 
Created
Source

ts-docs-gen

Readme is WIP.

Generates documentation from TypeScript files.

Get started

npm install ts-docs-gen -g

CLI usage

ts-docs-gen -h

Examples

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

Configuration

JSON config properties and CLI flags.

PropertyCLI FlagRequiredTypeDefaultDescription
--configoptionalstringRelative path to config json file.
entryFile--entryFilerequiredstring[]TypeScript project entry files.
project--project, -poptionalstringcwdFull path to TypeScript project directory.
output--output, -ooptionalstring./docs/api/Documentation output directory.
plugin--pluginoptionalstring[]Package name or path to plugin.
exclude--excludeoptionalstring[]File locations that should not be included generated documentation.
externalPackage--externalPackageoptionalstring[]External package names to include in extracted data.
excludePrivateApi--excludePrivateApioptionalbooleantrueExcludes api items that has access modifier set to "private" or JSDoc tag "@private".
verbosity--verbosityoptional"None", "Critical", "Error", "Warning", "Information", "Debug", "Trace""Information"Verbosity of output.
dryRun--dryRunoptionalbooleanGenerates markdown files but not writes them. Outputs generated data in Debug log level.

FAQs

Package last updated on 01 Feb 2018

Did you know?

Socket

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.

Install

Related posts