NAME
bb-doc - Backbase documentation generator
SYNOPSIS
bb-doc [--help] [-v|--version]
bb-doc js [--help] [-o|--output <path>] [-f|--format <format>] [source]
bb-doc site [--help] [--title <site title>] [-o|--output <path>] <source-zip>,<index-markdown>
OPTIONS
Option | Description |
---|---|
-v, --version | output the version number |
--help | Output usage information |
COMMANDS
NAME
bb-doc js
SYNOPSIS
bb-doc js [--help] [-o|--output <path>] [-f|--format <format>] [source]
OPTIONS
Option | Description |
---|---|
-o, --output <path> | Output directory (dist/docs) |
-f, --format <format> | Format of the output (md) |
--help | Output usage information |
EXAMPLES
$ bb-doc js ./src --output=/builds/my-build/doc
NAME
bb-doc site
SYNOPSIS
bb-doc site [--help] [--title <site title>] [-o|--output <path>] <source-zip>,<index-markdown>
OPTIONS
Option | Description |
---|---|
--title <site title> | Site title |
-o, --output <path> | Output directory (docs) |
--help | Output usage information |
ENVIRONMENT VARIABLES
Set the amount of log output
LOG_LEVEL=silly|verbose|info|warn|error
Set whether or not to use colors in output
COLOR=false|true