syntax-scribe

syntax-scribe

A new CLI generated with oclif

• Usage
• Commands

Usage

$ npm install -g syntax-scribe
$ syntax-scribe COMMAND
running command...
$ syntax-scribe (--version)
syntax-scribe/0.0.03 linux-x64 node-v22.14.0
$ syntax-scribe --help [COMMAND]
USAGE
  $ syntax-scribe COMMAND
...

Commands

• syntax-scribe
• Usage
• Commands
  • syntax-scribe docs
  • syntax-scribe docs build
  • syntax-scribe docs document
  • syntax-scribe docs init
  • syntax-scribe docs nav
  • syntax-scribe docs serve
  • syntax-scribe help [COMMAND]

syntax-scribe docs

Manage and preview MkDocs Material documentation site

USAGE
  $ syntax-scribe docs

DESCRIPTION
  Manage and preview MkDocs Material documentation site

EXAMPLES
  $ cli docs init --siteName="My Docs"

  $ cli docs nav

  $ cli docs serve

  $ cli docs build

syntax-scribe docs build

Build the static site using mkdocs build

USAGE
  $ syntax-scribe docs build -l <value> [-d <value>]

FLAGS
  -d, --dir=<value>         [default: docs-site] Project directory
  -l, --licenseKey=<value>  (required) syntax scribe license key

DESCRIPTION
  Build the static site using mkdocs build

EXAMPLES
  $ syntax-scribe docs build  -d docs-site -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx

  $ syntax-scribe docs build  -d /Users/patrickwright/gen/syntax-01/docs -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx

syntax-scribe docs document

Genearate documentation for a TypeScript or Javascript project.

USAGE
  $ syntax-scribe docs document -d <value> -l <value> -s <value>

FLAGS
  -d, --docDirectory=<value>     (required) directory to create documentation in
  -l, --licenseKey=<value>       (required) syntax scribe license key
  -s, --sourceDirectory=<value>  (required) source directory to document

DESCRIPTION
  Genearate documentation for a TypeScript or Javascript project.

EXAMPLES
  $ syntax-scribe docs document -s "/Users/patrickwright/code/my-typescript-project" -d /Users/patrickwright/gen/syntax-01/docs -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx

  $ syntax-scribe docs document -s "/Users/patrickwright/code/my-typescript-project" -d /Users/patrickwright/gen/syntax-01/docs

syntax-scribe docs init

Initialize a MkDocs Material documentation site

USAGE
  $ syntax-scribe docs init -l <value> [-d <value>] [-n <value>]

FLAGS
  -d, --dir=<value>         [default: docs-site] Output directory
  -l, --licenseKey=<value>  (required) syntax scribe license key
  -n, --siteName=<value>    [default: My Project Docs] Site name

DESCRIPTION
  Initialize a MkDocs Material documentation site

EXAMPLES
  $ syntax-scribe docs init  -d /Users/patrickwright/gen/syntax-01/docs -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx -n "My Project Docs"

  $ syntax-scribe docs init  -d /Users/patrickwright/gen/syntax-01/docs -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx

syntax-scribe docs nav

Regenerate the nav section of mkdocs.yml based on Markdown files

USAGE
  $ syntax-scribe docs nav -l <value> [-d <value>]

FLAGS
  -d, --dir=<value>         [default: docs-site] Project directory
  -l, --licenseKey=<value>  (required) syntax scribe license key

DESCRIPTION
  Regenerate the nav section of mkdocs.yml based on Markdown files

EXAMPLES
  $ syntax-scribe docs nav  -d /Users/patrickwright/gen/syntax-01/docs -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx "

syntax-scribe docs serve

Serve your documentation locally using mkdocs serve

USAGE
  $ syntax-scribe docs serve -l <value> [-d <value>]

FLAGS
  -d, --dir=<value>         [default: docs-site] Project directory
  -l, --licenseKey=<value>  (required) syntax scribe license key

DESCRIPTION
  Serve your documentation locally using mkdocs serve

EXAMPLES
  $ syntax-scribe docs serve  -d /Users/patrickwright/gen/syntax-01/docs -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx "

syntax-scribe help [COMMAND]

Display help for syntax-scribe.

USAGE
  $ syntax-scribe help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for syntax-scribe.