docs/README.md

Spacebar Docs

How to get started

1. Fork this repository.

2. Clone the forked repository.

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

3. Install dependencies.

   python3 -m pip install -r requirements.txt
   

4. 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.

5. Test locally.

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

     python3 -m mkdocs serve
     

   • Build for production:

     python3 -m mkdocs build
     

6. Commit changes with good commit messages.

7. Create a pull request.