This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

@bb-cli/bb-doc

2.0.2 • Public • Published

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

Readme

Keywords

Package Sidebar

Install

npm i @bb-cli/bb-doc

Weekly Downloads

1

Version

2.0.2

License

SEE LICENSE IN LICENSE

Unpacked Size

120 kB

Total Files

40

Last publish

Collaborators

  • backbase-admin
  • bb-cli