npm install
npm run start
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
- Have you pulled latest from
main
? - Have you run
npm install
? When we update dependencies in the project, they don't automatically update in your environment. You'll need to runnpm install
occasionally to acquire dependency updates locally.
It's rare to build the docs locally -- running the dev server with npm run start
meets most development needs.
Sometimes it can be helpful to see what docusaurus is generating, though. Use one of the following commands to generate static content of the full docs site in a build
directory:
npm run build
npm run build:docker
The local build consumes a lot of local resources. You might find the :docker
version to be less disruptive of your local environment.
Both commands generates static content into the build
director, and can be served using any static contents hosting service.
Deployments are handled by creating a new Release. See release-procedure.md for details.