Docusaurus

Installation

npm

npm install

Yarn

yarn install

pnpm

pnpm install

Local Development

npm

npm run start

Yarn

yarn run start

pnpm

pnpm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm

npm run build

Yarn

yarn build

pnpm

pnpm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH

USE_SSH=true yarn deploy

Not using SSH

GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Bash

GIT_USER=<GITHUB_USERNAME> yarn deploy

Windows

cmd /C "set "GIT_USER=<GITHUB_USERNAME>" && yarn deploy"

Powershell

cmd /C 'set "GIT_USER=<GITHUB_USERNAME>" && yarn deploy'

Learn more

🗃️ Basics

6 items

🗃️ Extras

2 items