External documentation of the GrantShares program app and smart contracts.
This documentation site is built using Docusaurus 2.
The Docusaurus versioned used in this repo requires a node.js installation of at least version 16.14. Node is available here.
If you already have node installed use the Node Version Manager command line tool to install the required version (e.g., nvm install 16.14) or switch to it (e.g., nvm use 16.14).
You will also need Yarn, which you can install after you've installed node.
npm install --global yarnClone this repository.
git clone https://github.com/AxLabs/grantshares-docs.git
cd grantshares-docs
Install the dependencies.
$ yarn install
Build the docs website and run a local dev server. The docs are served at http://localhost:3000/. Most changes in the source code are reflected live without having to restart the server.
$ yarn start
Generate static content into the build directory that can be served using any static contents hosting service.
$ yarn build