https://github.com/spacebarchat/docs

Docs for Spacebar
https://github.com/spacebarchat/docs

instant-messaging mkdocs mkdocs-material real-time-communication spacebarchat

Last synced: 6 days ago
JSON representation

Docs for Spacebar

• Host: GitHub
• URL: https://github.com/spacebarchat/docs
• Owner: spacebarchat
• License: other
• Created: 2021-05-14T08:49:20.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-11-02T23:17:19.000Z (3 months ago)
• Last Synced: 2025-01-07T20:10:07.002Z (14 days ago)
• Topics: instant-messaging, mkdocs, mkdocs-material, real-time-communication, spacebarchat
• Homepage: https://docs.spacebar.chat
• Size: 10.8 MB
• Stars: 44
• Watchers: 4
• Forks: 51
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing/index.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Spacebar Docs

[![Build to GitHub Pages](https://github.com/spacebarchat/docs/actions/workflows/build.yml/badge.svg)](https://github.com/spacebarchat/docs/actions/workflows/build.yml)

[![Netlify Status](https://api.netlify.com/api/v1/badges/86622c9d-4952-4da5-9825-cc016e4a5e5f/deploy-status)](https://app.netlify.com/sites/spacebar-chat/deploys)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/spacebarchat/docs)

## How to get started

1. Fork this repository.

2. Clone the forked repository.

    ```bash

    git clone https://github.com//docs

    ```

3. Install dependencies.

    ```bash

    python3 -m pip install -r requirements.txt

    ```

4. Edit documents(s).

    - Format document(s).

    Spacebar uses [prettier](https://prettier.io) formatter to consistently format our documents. Instructions to install and use prettier can be found [here](https://prettier.io/docs/en/install.html).

    If you are using vscode, install the [prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) to automatically format documents on save.

5. Test locally.

    - Serve in  with hot reload:

        ```bash

        python3 -m mkdocs serve

        ```

    - Build for production:

        ```bash

        python3 -m mkdocs build

        ```

6. Commit changes with good commit messages.

7. Create a pull request.