devkeeper-docs

Opinionated CLI to generate README and build VuePress. It may be used in CI/CD such as GitHub actions.

• Synopsis
• Details
  • README
  • VuePress
• CLI

Synopsis

$ npx devkeeper-docs readme

Build opinionated VuePress

$ npx devkeeper-docs vuepress

Details

README

$ npx devkeeper-docs readme

• Creates README.md from README.njk nunjucks template using readmeasy.
• If there is no README.njk template, creates one.
• Adds header with {% include "module-header" %} (name, description table of contents, badges). See readmeasy for details.
• Adds API documentation with {% include "api.md" %} using TypeDoc.
• Adds oclif CLI tool README parts if oclif is used in project.

VuePress

$ npx devkeeper-docs vuepress

Builds VuePress. We suggest you to use vuepress-bar to easily create VuePress sidabar and top menu.

CLI

$ npm install -g devkeeper-docs
$ devkeeper-docs COMMAND
running command...
$ devkeeper-docs (-v|--version|version)
devkeeper-docs/0.1.15 darwin-x64 node-v14.1.0
$ devkeeper-docs --help [COMMAND]
USAGE
  $ devkeeper-docs COMMAND
...

• devkeeper-docs add-scripts
• devkeeper-docs autocomplete [SHELL]
• devkeeper-docs help [COMMAND]
• devkeeper-docs readme
• devkeeper-docs typedoc-html
• devkeeper-docs typedoc-md
• devkeeper-docs typedoc-single-md
• devkeeper-docs vuepress
• devkeeper-docs vuepress-dev

devkeeper-docs add-scripts

Creates Readme from TypeScript and README template using readmeasy and Typeoc.

USAGE
  $ devkeeper-docs add-scripts

See code: lib/commands/add-scripts.js

devkeeper-docs autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ devkeeper-docs autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ devkeeper-docs autocomplete
  $ devkeeper-docs autocomplete bash
  $ devkeeper-docs autocomplete zsh
  $ devkeeper-docs autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

devkeeper-docs help [COMMAND]

display help for devkeeper-docs

USAGE
  $ devkeeper-docs help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

devkeeper-docs readme

Creates Readme from TypeScript and README template using readmeasy and Typeoc.

USAGE
  $ devkeeper-docs readme

See code: lib/commands/readme.js

devkeeper-docs typedoc-html

Using typedoc, creates series of HTML files from TypeScript files

USAGE
  $ devkeeper-docs typedoc-html

See code: lib/commands/typedoc-html.js

devkeeper-docs typedoc-md

Using typedoc, creates a series of MarkDown files from TypeScript files.

USAGE
  $ devkeeper-docs typedoc-md

See code: lib/commands/typedoc-md.js

devkeeper-docs typedoc-single-md

Using typedoc, creates a MarkDown files from TypeScript files

USAGE
  $ devkeeper-docs typedoc-single-md

See code: lib/commands/typedoc-single-md.js

devkeeper-docs vuepress

Builds VuePress Site

USAGE
  $ devkeeper-docs vuepress

See code: lib/commands/vuepress.js

devkeeper-docs vuepress-dev

Starts VuePress development server.

USAGE
  $ devkeeper-docs vuepress-dev

See code: lib/commands/vuepress-dev.js