furkanenes19 / availproject.github.io

Documentation for Avail

Avail Docs

This repo contains the code for the website containing Avail documentation. The website is deployed at availproject.github.io.

If you are interested to know more about the project, follow us on Twitter or join us on Discord.

Development and Deployment

• To install it locally, use

  $ yarn
  

• To start a development server locally, use

  $ yarn start
  

• To deploy on gh-pages branch using SSH, use

  $ USE_SSH=true yarn deploy
  

• To deploy on gh-pages branch without using SSH, use

  $ GIT_USER=<Your GitHub username> yarn deploy
  

^{This website is built using Docusaurus 2, a modern static website generator.}