Fork this repository.

Clone the forked repository.

git clone https://github.com/<YOUR_USERNAME_HERE>/docs

Install dependencies.

python3 -m pip install -r requirements.txt

Edit documents(s).

• Format document(s).

Spacebar uses prettier formatter to consistently format our documents. Instructions to install and use prettier can be found here.

If you are using vscode, install the prettier extension to automatically format documents on save.

Test locally.

• Serve in http://127.0.0.1:8000 with hot reload:

  python3 -m mkdocs serve

• Build for production:

  python3 -m mkdocs build

Commit changes with good commit messages.

Create a pull request.