To build and serve the site, you'll need the latest [LTS release] of Node. Like Netlify, we use [nvm], the Node Version Manager, to install and manage Node versions:
$ nvm install --lts
- Clone this repo.
- From a terminal window, change to the cloned repo directory.
- Get NPM packages and git submodules, including the the Docsy theme:
$ npm install
To locally serve the site at localhost:1313 , run the following command:
$ npm run serve
To build and check links, run these commands:
$ npm run build $ npm run check-links
You can also locally serve using Docker:
$ make docker-serve
We welcome issues and PRs! For details, see Contributing.