Docs for Spacebar
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Madeline 9eaf17dc44
Merge pull request #75 from bitfl0wer/main
Add mention of dev client, fix typo
3 weeks ago
.github Update build.yml 1 month ago
.vscode Prettier! 2 months ago
docs Run prettier 3 weeks ago
.gitignore Add venv/ to .gitignore 3 months ago
.prettierrc prettier 5 months ago
LICENSE Update LICENSE 2 years ago Push Major Rebrand 2 months ago
mkdocs.yml use rapidoc for http api documentation 1 month ago
package.json add package.json 5 months ago
requirements.txt Add mkdocs-macros-plugin dependency 3 months ago

Spacebar Docs

Build to GitHub Pages code style: prettier

Deploy with Vercel

How to get started

  1. Fork this repository.

  2. Clone the forked repository.

    git clone<YOUR_USERNAME_HERE>/docs
  3. Install dependencies.

    python3 -m pip install mkdocs-material mkdocs-swagger-ui-tag mkdocs-section-index mkdocs-macros-plugin
  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 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.