Commands

Doks comes with commands for common tasks.

create #

Create new content for your site:

npm run create [path] [flags]

See also the Hugo docs: hugo new.

Docs based tree #

Create a docs based tree — with a single command:

npm run create -- --kind docs [section]

For example, create a docs based tree named guides:

npm run create -- --kind docs guides

lint #

Check scripts, styles, and markdown for errors:

npm run lint

scripts #

Check scripts for errors:

npm run lint:scripts [-- --fix]

styles #

Check styles for errors:

npm run lint:styles [-- --fix]

markdown #

Check markdown for errors:

npm run lint:markdown [-- --fix]

clean #

Delete temporary directories:

npm run clean

start #

Start local development server:

npm run start

build #

Build production website:

npm run build

functions #

Build Lambda functions:

npm run build:functions

preview #

Build production website including draft and future content:

npm run build:preview