Skip to main content

📚 Documentation Scripts

npm run docs​

Runs whatever scripts are inside the /docs directory (Docusaurus) from the project's root.

npm run --prefix docs

Used for dev/staging/production documentation commands depending on what's in docs/package.json.

All of the commands below can be run using the command below (e.g., npm run docs start)

Docusaurus-Only Commands​

These commands can ony be run from the /docs folder unless you use the exception mentioned above.

npm run start​

Starts the Docusaurus development server.

  • Hot reload enabled
  • Runs at http://localhost:3000
  • Rebuilds instantly when editing MDX or config
docusaurus start

npm run build​

Builds the full production static site into:

docusaurus build

npm run swizzle​

Builds the full production static site into:

docusaurus swizzle

npm run deploy​

Builds the full production static site into:

docusaurus deploy

npm run clear​

Builds the full production static site into:

docusaurus clear

npm run serve​

Builds the full production static site into:

docusaurus serve

npm run write-translations​

Builds the full production static site into:

docusaurus write-translations

npm run write-heading-ids​

Builds the full production static site into:

docusaurus write-heading-ids