eden-network/docs

Eden Docs

These docs are built using Docusaurus 2, a modern static website generator. They are a work in progress, please file any issues you find on GitHub and/or read our contribution guide to submit a PR with your changes.

If you have any questions, feel free to reach out on our Discord.

Installation

First create a copy of the environment file .env.template in the root of the codebase and rename it to .env

Then run the following:

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

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

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true 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.