@adobe/aio-cli-plugin-doc

2.0.1 • Public • Published

Adobe I/O CLI Documentation Website Plugin

Generates a starter documentation website powered by Gatsby.

oclif Version Downloads/week Build Status License Codecov Coverage

doc commands for the Adobe I/O CLI

Usage

$ aio plugins:install @adobe/aio-cli-plugin-doc
$ # OR
$ aio discover -i
$ aio doc --help

Commands

aio doc:clean [PATH]

Clean the documentation site

USAGE
  $ aio doc:clean [PATH]

ARGUMENTS
  PATH  [default: .] Path to the doc directory

See code: src/commands/doc/clean.js

aio doc:generate [PATH]

Generate the production docs

USAGE
  $ aio doc:generate [PATH]

ARGUMENTS
  PATH  [default: .] Path to the doc directory

See code: src/commands/doc/generate.js

aio doc:init [PATH]

Create a new Adobe I/O doc site

USAGE
  $ aio doc:init [PATH]

ARGUMENTS
  PATH  [default: .] Path to the doc directory

OPTIONS
  -t, --template=template  the template to install (url to a git repo)

See code: src/commands/doc/init.js

aio doc:run [PATH]

Run a development version of the docs locally

USAGE
  $ aio doc:run [PATH]

ARGUMENTS
  PATH  [default: .] Path to the doc directory

See code: src/commands/doc/run.js

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.

Readme

Keywords

Package Sidebar

Install

npm i @adobe/aio-cli-plugin-doc

Weekly Downloads

3

Version

2.0.1

License

Apache-2.0

Unpacked Size

42.5 kB

Total Files

15

Last publish

Collaborators

  • dylandepass
  • djaeggi
  • adobehalls
  • fullcolorcoder
  • marbec
  • tripod
  • garthdb
  • lazd
  • adobe-admin
  • patrickfulton
  • trieloff
  • shazron
  • krisnye
  • dcpfsdk
  • natebaldwin
  • devongovett
  • aspro83
  • symanovi
  • dpfister
  • stefan-guggisberg
  • korra
  • rofe
  • kptdobe