@wix/docs-md-images v1.0.7

@wix/docs-ts-model

Wix docs model generator for TypeScript projects.

Installation

npm install @wix/docs-ts-model --save-dev

Usage

To generate documentation model @wix/docs-ts-model needs to know your project entry point.

docs-ts-model --entryPoint src/index.ts

Arguments

For a complete list of the command line arguments run docs-ts-model --help.

• --entryPoint <path/to/index.ts> Specifies the entry point of your project.
• --tsconfigt <path/to/tsconfig.json> Specifies the tsconfig.json of your project. Defaults to ./tsconfig.json
• --basePath <path/to/project-dir> Specifies the location of your project relative to the working directory.
• --outDir Specifies the location the documentation model should be written to. Defaults to ./doc-model
• --modelName <docs-model.json> Specify the doc model file name. Defaults to model.json
• --name <name-of-doc-model-project> Specify the name of the project that will be used in the header of the template. Defaults to package name.