Spacebar/docs
1
0
Fork 0
mirror of https://github.com/spacebarchat/docs.git synced 2024-09-19 15:11:44 +02:00
Code Issues Releases Activity

Push Major Rebrand

Browse Source
This commit is contained in:
ChrisChrome 2023-03-30 08:13:55 -06:00
parent 2602f0511a
commit 8ccd59002e
No known key found for this signature in database
GPG Key ID: A023A26E42C33A42
8 changed files with 24 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/build.yml vendored
View File

@ -14,7 +14,7 @@ jobs:
python-version: 3.x
- run: python3 -m pip install mkdocs-material mkdocs-swagger-ui-tag mkdocs-section-index mkdocs-macros-plugin
- run: mkdocs build
- run: echo docs.fosscord.com >> site/CNAME
- run: echo docs.spacebar.chat >> site/CNAME
- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@4.1.3
with:

1
.vscode/settings.json vendored
View File

@ -1,6 +1,5 @@
{
"cSpell.words": [
"Fosscord",
"landingpage",
"Middlewares",
"Roadmap",

10
README.md
View File

@ -1,8 +1,8 @@
# Fosscord Docs
# Spacebar Docs
[![Build to GitHub Pages](https://github.com/fosscord/fosscord-docs/actions/workflows/build.yml/badge.svg)](https://github.com/fosscord/fosscord-docs/actions/workflows/build.yml) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Build to GitHub Pages](https://github.com/spacebarchat/docs/actions/workflows/build.yml/badge.svg)](https://github.com/spacebarchat/docs/actions/workflows/build.yml) [![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/fosscord/fosscord-docs)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/spacebarchat/docs)
## How to get started
@ -10,7 +10,7 @@
2. Clone the forked repository.
```bash
git clone https://github.com/<YOUR_USERNAME_HERE>/fosscord-docs
git clone https://github.com/<YOUR_USERNAME_HERE>/docs
```
3. Install dependencies.
@ -23,7 +23,7 @@
- Format document(s).
fosscord 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).
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.

BIN
docs/assets/banner.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 190 KiB

After

Width:  |  Height:  |  Size: 76 KiB

7
docs/assets/favicon.svg
View File

@ -1,4 +1,3 @@
<svg width="50" height="50" viewBox="0 0 50 50" fill="#ff6e42"
xmlns="http://www.w3.org/2000/svg">
<path d="M 0,0 47.999993,2.7036528e-4 C 48.001796,3.3028172 47.663993,6.5968018 46.991821,9.8301938 43.116101,28.454191 28.452575,43.116441 9.8293509,46.992163 6.5960834,47.664163 3.3023222,48.001868 0,47.999992 Z m 9.8293509,28.735114 v 9.248482 C 22.673599,33.047696 32.857154,22.749268 37.63852,9.829938 H 9.8293509 v 8.679899 H 22.931288 c -3.554489,3.93617 -7.735383,7.257633 -12.373436,9.829938 -0.241031,0.133684 -0.483864,0.265492 -0.7285011,0.395339 z"/>
</svg>
<svg width="658" height="512" viewBox="0 0 658 512" fill="none" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" clip-rule="evenodd" d="M654.761 336.716C663.96 379.493 653.33 424.14 625.846 458.177C598.359 492.218 556.96 512 513.219 512H144.781C101.04 512 59.6412 492.218 32.1568 458.177C4.6698 424.14 -5.96029 379.493 3.23881 336.716L68.114 34.9913C71.1347 20.9403 80.7803 9.2276 93.9899 3.57439C107.199 -2.08151 122.33 -0.975653 134.576 6.53954L329 125.838L523.424 6.53954C535.67 -0.975653 550.801 -2.08151 564.01 3.57439C577.22 9.2276 586.865 20.9403 589.886 34.9913L654.761 336.716ZM505.695 267.123C505.695 245.263 487.98 227.542 466.128 227.542H389.9C368.048 227.542 350.335 245.263 350.335 267.123V343.378C350.335 365.237 368.048 382.956 389.9 382.956H466.128C487.98 382.956 505.695 365.237 505.695 343.378V267.123ZM307.665 267.123C307.665 245.263 289.952 227.542 268.1 227.542H191.871C170.02 227.542 152.305 245.263 152.305 267.123V343.378C152.305 365.237 170.02 382.956 191.871 382.956H268.1C289.952 382.956 307.665 365.237 307.665 343.378V267.123Z" fill="#0185FF"/>
</svg>

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 571 B

After

Width:  |  Height:  |  Size: 1.1 KiB

2
docs/assets/js/missingroutes.js
View File

@ -1,5 +1,5 @@
const MISSING_ROUTES_LIST =
"https://raw.githubusercontent.com/fosscord/fosscord-missing-routes/main/missing.json";
"https://raw.githubusercontent.com/spacebarchat/missing-routes/main/missing.json";
const listMount = document.getElementById("missing-routes-list");
document

7
docs/assets/logo.svg
View File

@ -1,4 +1,3 @@
<svg width="50" height="50" viewBox="0 0 50 50" fill="white"
xmlns="http://www.w3.org/2000/svg">
<path d="M 0,0 47.999993,2.7036528e-4 C 48.001796,3.3028172 47.663993,6.5968018 46.991821,9.8301938 43.116101,28.454191 28.452575,43.116441 9.8293509,46.992163 6.5960834,47.664163 3.3023222,48.001868 0,47.999992 Z m 9.8293509,28.735114 v 9.248482 C 22.673599,33.047696 32.857154,22.749268 37.63852,9.829938 H 9.8293509 v 8.679899 H 22.931288 c -3.554489,3.93617 -7.735383,7.257633 -12.373436,9.829938 -0.241031,0.133684 -0.483864,0.265492 -0.7285011,0.395339 z"/>
</svg>
<svg width="658" height="512" viewBox="0 0 658 512" fill="none" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" clip-rule="evenodd" d="M654.761 336.716C663.96 379.493 653.33 424.14 625.846 458.177C598.359 492.218 556.96 512 513.219 512H144.781C101.04 512 59.6412 492.218 32.1568 458.177C4.6698 424.14 -5.96029 379.493 3.23881 336.716L68.114 34.9913C71.1347 20.9403 80.7803 9.2276 93.9899 3.57439C107.199 -2.08151 122.33 -0.975653 134.576 6.53954L329 125.838L523.424 6.53954C535.67 -0.975653 550.801 -2.08151 564.01 3.57439C577.22 9.2276 586.865 20.9403 589.886 34.9913L654.761 336.716ZM505.695 267.123C505.695 245.263 487.98 227.542 466.128 227.542H389.9C368.048 227.542 350.335 245.263 350.335 267.123V343.378C350.335 365.237 368.048 382.956 389.9 382.956H466.128C487.98 382.956 505.695 365.237 505.695 343.378V267.123ZM307.665 267.123C307.665 245.263 289.952 227.542 268.1 227.542H191.871C170.02 227.542 152.305 245.263 152.305 267.123V343.378C152.305 365.237 170.02 382.956 191.871 382.956H268.1C289.952 382.956 307.665 365.237 307.665 343.378V267.123Z" fill="white"/>
</svg>

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 569 B

After

Width:  |  Height:  |  Size: 1.1 KiB

22
mkdocs.yml
View File

@ -5,18 +5,18 @@ extra:
# For more information, read https://mkdocs-macros-plugin.readthedocs.io/en/latest/ .
#
project:
name: Fosscord # Tip: use {{ project_name.lower() }} to get the project name in lowercase.
domain: fosscord.com
name: Spacebar # Tip: use {{ project_name.lower() }} to get the project name in lowercase.
domain: spacebar.chat
repositories:
base_url: https://github.com/
server: fosscord/fosscord-server
client: fosscord/fosscord-client
missing_routes: fosscord/fosscord-missing-routes
main: &repo_url https://github.com/fosscord/fosscord # This gets read by mkdocs without being pre-proccessed by mkdocs-macros, which is why the URL is in full.
server: spacebarchat/server
client: spacebarchat/client
missing_routes: spacebarchat/missing-routes
main: &repo_url https://github.com/spacebarchat/spacebarchat # This gets read by mkdocs without being pre-proccessed by mkdocs-macros, which is why the URL is in full.
site:
name: &site_name Fosscord Documentation
description: &site_description "Documentation for Fosscord: a free open source selfhostable chat, voice and video discord-compatible platform"
edit_uri: &edit_uri https://github.com/fosscord/fosscord-docs/edit/master/docs/ # This gets read by mkdocs without being pre-proccessed by mkdocs-macros, which is why the URL is in full.
name: &site_name Spacebar Documentation
description: &site_description "Documentation for Spacebar: a free open source selfhostable chat, voice and video discord-compatible platform"
edit_uri: &edit_uri https://github.com/spacebarchat/docs/edit/master/docs/ # This gets read by mkdocs without being pre-proccessed by mkdocs-macros, which is why the URL is in full.
site_name: *site_name
repo_url: *repo_url
edit_uri: *edit_uri
@ -36,13 +36,13 @@ theme:
font: Open Sans
palette:
- media: "(prefers-color-scheme: light)"
primary: deep-orange
primary: #0185ff
scheme: default
toggle:
icon: material/lightbulb-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
primary: deep-orange
primary: #0185ff
scheme: slate
toggle:
icon: material/lightbulb