Skip to content

spacebarchat/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

2d48d68 · Nov 2, 2024
Aug 22, 2023
Apr 8, 2023
Sep 23, 2024
Mar 18, 2023
Jan 2, 2023
May 14, 2021
Aug 31, 2023
Aug 22, 2023
Aug 31, 2023
Jan 15, 2023
Aug 22, 2023
Aug 31, 2023

Repository files navigation

Spacebar Docs

Build to GitHub Pages Netlify Status code style: prettier

Deploy with Vercel

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.