Agora documentation website uses Docusaurus to generate the static documentation website. It also uses MDX and React as the frontend framework. The actual contents of the website (in MDX) lives in a git submodule repository.
In order to build the Agora documentation using this repo you must have to have installed Nodejs >= 16.8.0
on your system.
- Clone the repository using your terminal:
git clone https://github.com/AgoraIO/Docs.git
- In Terminal, navigate to the root folder of this repository.Initiate the submodules:
cd Docs
git submodule sync --recursive
git submodule update --init --remote --recursive
git pull --recurse-submodules
- Installation
yarn
- Local Development
yarn start
- Build
yarn build