# Command: doc html

Command kl doc html creates html documentation for kumologica project.

The documentation is created in build subdirectory of kumologica project.

# Usage

Usage: kl doc html [options]

  • -d, --project-directory - Kumologica project directory, current working directory if not provided
  • -f, --flow-file-name - The file name of kumologica flow, must end with .json extension. Auto search if not provided
  • -c, --documentation-directory - The name of subdirectory where documentation should be created, docs if not provided

# Example: Create documentation with default options

Command creates documentation for kumologica project using default options.

$ cd /Users/john/Projects/accounts-service
$ kl doc html

Command will create directory docs within /Users/john/Projects/accounts-service/build directory. After completion of the command, the content of /Users/john/Projects/accounts-service/build/docs directory will contain following files:

/Users/john/Projects/accounts-service/build/docs
 - /assets
 - index.html

# Example: Create documentation with custom options

Command creates documentation for kumologica project with custom documentation directory, flow name and project directory.

$ cd /Users/john/Projects/accounts-service
$ kl doc html -d html-docs -k . -f accounts-service-flow.json

Command will create directory html-docs within /Users/john/Projects/accounts-service/build directory. After completion of the command, the content of /Users/john/Projects/accounts-service/build/html-docs directory will contain following files:

/Users/john/Projects/accounts-service/build/html-docs
 - /assets
 - index.html

← Export Cloudformation →