Preview the docs

Use npm or Yarn to preview your documentation changes locally before pushing them to your remote branch.

Make sure you have Node.js version 16+ and npm installed.

tip

If you're using Node.js with nvm (recommended), run nvm use to automatically choose the right Node.js version.

note

If you make changes to a versioned doc site (for example, Teku), the changes only appear in the development version of the docs. Switch to the development version of the preview to see those changes.

npm

In the doc repository, run the following commands to start a local development server and preview your changes:

npm install
npm start

note

If you make changes to the redirects, you can preview them by running npm run build && npm run serve.

Yarn

Make sure you have Yarn version 3 installed.

In the doc repository, run the following commands to start a local development server and preview your changes:

yarn install
yarn start

note

If you make changes to the redirects, you can preview them by running yarn build && yarn serve.