This repository holds the Docusaurus instance that hosts the Yerbas Docs (https://docs.yerbas.org). Development is also done here.
Contributors are always welcome to help us out with anything they can. If you're not proficient in using code or development software, bring us a visit on Discord! (discord.gg/yerbas). You can help us in other ways that don't require coding skills. :)
- Build local files:
yarn build
(equivalent toyarn docusaurus build
) Builds the current instance and leaves the built files in/build/
- Host local files:
yarn serve
(equivalent toyarn docusaurus serve
) Opens a webserver on port 3000
Search will not create indexes until yarn build
is ran.
A Docker image can be built directly from this repository's source. When doing so, the above commands are executed automatically. Note this may take some time to finish.
- NodeJS
- Yarn (Package Manager)
- Visual Studio Code
- Docker / Docker Desktop (optional, dev containers)
-
To build the Docker image, start off by cloning this repository to a directory of your choosing:
sudo git clone https://github.com/The-Yerbas-Endeavor/docs
-
Navigate to the cloned repository's root directory.
-
Build the container:
sudo docker build . -t yerbas/docs
-
Run the container:
sudo docker run -p -d yerbas/docs
- -p opens the ports specified in the Dockerfile
- -d specifies detatched
This will make the applications accessible on port 3000 (localhost or otherwise)