Notary Project Website

The notaryproject.dev website, built using Hugo and hosted on Netlify.

Cloud build

Visit https://gitpod.io/#https://github.com/notaryproject/notaryproject.dev to launch a Gitpod.io IDE that will allow you to build, preview and make changes to this repo.

Local build

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

Setup

1. Clone this repo.
2. From a terminal window, change to the cloned repo directory.
3. Get NPM packages and git submodules, including the the Docsy theme:

   $ npm install

Build or serve the site

To locally serve the site at localhost:8888, run the following command:

$ npm run serve

To build and check links, run these commands:

$ npm run build
$ npm run check-links

License

notaryproject.dev is licensed under an Apache 2.0 license.

The Notary Project documentation (e.g., .md files in the /content/docs folder) is licensed under a CC-BY-4.0 license.