Docus CLI

The Docus CLI.

Quick Setup

Add docus package globally:

# Using Yarn
yarn global add docus

# Using NPM
npm install --global docus

Commands

npm init docus

This package is also responsible for the npm init docus command.

You can use it without installing docus package globally.

-- is required as specified here.

npm init docus -- path/to/project

npm init docus -- --type="module" path/to/project

npm init docus -- --type="theme" path/to/project

create-docus

If you install the docus package globally, it will be shipped with create-docus executable.

This allows the creation of a Docus project, a theme or a module.

You can execute this command anywhere:

create-docus path/to/project

create-docus --type="module" path/to/project

create-docus --type="theme" path/to/project

Development

1. Clone this repository
2. Install dependencies using yarn install
3. Start dev server using yarn dev