For contributing rules, please visit this page.
The Guide is built using Docusaurus 2, a modern static website generator.
/src contains styling (.scss) and the index (.tsx/jsx).
/docs contains the pages for the guide. The Documentation pages are writtern in the md/mdx file format, a combination of Markdown syntax and JSX/React.
First, you need to clone the repository:
git clone https://github.com/discordbump/docs
You need to install the requirements for the guide, which you may do by running the following command:
yarn
Then, you can start the server by running the following command:
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.
Then, you can build the website by running the following command:
yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.