Skip to content

HorizenLabs/zkverify-docs

Repository files navigation

Website

This website is built using Docusaurus, a modern static website generator.

Installation

$ yarn

Local Development

  1. Copy the example .env file:
cp .env.template .env
  • Note: The default values seem to work for local development but refer to KeePass for the actual ALGOLIA_APP_ID, ALGOLIA_API_KEY, and ALGOLIA_INDEX_NAME details.
  1. Start a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
$ yarn start

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.