Docs Development

Getting Started

Use newer versions of Nodejs. Currently the builds on GitHub are using v20. Mac users (Apple silicon) should see the page Rosetta, Nodejs, esbuild if you get an error.

Nodejs v20

It is best to use nodejs v20 which gives the best performance and is the engine described in the package.json file.

Clone the remote repo

Clone the remote repo and install it packages.

git clone git@github.com:api3dao/vitepress-docs.git
cd vitepress-docs
pnpm install

Create a working branch.

git checkout -b <branch-name>

Run the development server.

pnpm docs:dev

Push the working branch

Before pushing your working branch to the remote repo, be sure that the branch builds.

pnpm docs:build

The output should look like this:

  vitepress v1.0.0-alpha.61

✓ building client + server bundles...
✓ rendering pages...
build complete in 5.20s.
✨  Done in 6.19s.

If the build displays errors or warnings (such as broken links) address them as needed.

Memory

It maybe necessary to increase the memory for Nodejs to run pnpm docs:dev or pnpm docs:build. This can be done with the command below, with a higher value potentially necessary. For Apple silicon this may be a sign of a Rosetta issue which should be addressed before committing to additional memory for Nodejs.

export NODE_OPTIONS=--max_old_space_size=1024