Skip to main content

Preview Docs Locally

It is important that you preview docs locally before pushing to git. It also offers a faster route to getting things done rather than waiting for the CloudFlare host to complete the build.

What you'll need​

  • Node.js version 20.0 or above:
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Start your site​

Run the development server:

cd documentation
npm run start

The cd command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.

The npm run start command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.

Open docs/build_docs_local.md (this page) and edit some lines: the site reloads automatically and displays your changes.