muchfungible / docs

Technical Documentation for the Hifi Protocol

Hifi Docs

Contributing to the Hifi docs is a great way to get involved in the dev community and help other people along the way.

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

Prerequisites

• NVM
• Yarn package manager

Installation

1. Clone the repository:

$ git clone https://github.com/hifi-finance/docs.git
$ cd docs

2. Set the version of Node to use locally within the project:

$ nvm use

3. Install the dependencies with Yarn:

$ yarn install

Local Development

$ yarn start

This command starts a local development server and opens 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.