Skip to main content
Version: current

Commands

The Makersaurus CLI is used to create, run and build Makersaurus projects. You can also use it to generate template readme files.

tip

When using npx you must specify the version of Makersaurus you wish to run. Unless you have a specific reason to use an old version, stick to npx @h2oai/makersaurus@latest

create-new-project​

Usage: makersaurus create-new-project [options]

Create a new Makersaurus project

Options:
  -o, --out   name of output directory (default: 'documentation')
  -h, --help  display help for command

Here is an example of creating a new project in a custom directory:

$ npx @h2oai/makersaurus@latest create-new-project --out=my-docs

start​

Alias: npm start

Usage: makersaurus start [options]

Serve docs site on http://localhost:3000/. Requires 'docs' folder, 'sidebars.js' and 'makersaurus.config.js' in the root directory

Options:
  -i, --input  name of input directory (default: '.')
  -o, --output  name of output directory (default: './tmp')
  --no-versions  do not include versioned docs
  -h, --help   display help for command

build​

Alias: npm run build

Usage: makersaurus build [options]

Build static site for deployment. Requires 'docs' folder, 'sidebars.js' and 'makersaurus.config.js' in the root directory

Options:
  -i, --input  name of input directory (default: '.')
  --copy  after build is finished copy static site to another directory
  --no-versions  do not include versioned docs
  -h, --help   display help for command

serve​

Alias: npm run serve

Usage: makersaurus serve [options]

Server for testing static builds. Run '@h2oai/makersaurus build' first

Options:
  -i, --input  name of input directory (default: '.')
  -h, --help   display help for command

deploy​

Alias: npm run deploy.

Usage: makersaurus deploy [options]

Deploy static site. Run '@h2oai/makersaurus build' first

Options:
  -i, --input  name of input directory (default: '.')
  -h, --help   display help for command
tip

The deploy command will fail unless you have permission to push to the repo

scaffold​

Alias: npm scaffold

Usage: makersaurus scaffold [options]

Create the docusaurus project without running anything. Requires 'docs' folder, 'sidebars.js' and 'makersaurus.config.js' in the root directory

Options:
  -i, --input <string>   name of input directory (default: '.') (default: ".")
  -o, --output <string>  name of output directory (default: 'tmp') (default: "./tmp")
  --no-versions  do not include versioned docs
  -h, --help             display help for command

gen-readme​

Generate a README.md template

Options:
  --makersaurusPath <string>  path to makersaurus project (default: "documentation")
  --versioned                 whether the documentation is versioned (default: false)
  --docsUrl <string>          the URL of the deployed documentation (default: "{{ INSERT_DOCS_URL }}")
  -h, --help                  display help for command

gen-makefile​

Usage: makersaurus gen-makefile [options]

Generate a Makefile template

Options:
  --makersaurusPath <string>  path to makersaurus project (default: "documentation")
  -h, --help                  display help for command

gen-deployment​

Usage: makersaurus gen-deployment [options]

Generate a Github pages deployment template

Options:
  --makersaurusPath <string>  path to makersaurus project (default: "documentation")
  --adminUsername <string>    repository admin username (default: "{{ INSERT_REPO_ADMIN_USERNAME
                              }}")
  --adminEmail <string>       repository admin email address (default: "{{
                              INSERT_REPO_ADMIN_USERNAME }}")
  -h, --help                  display help for command
Feedback