mirror of https://github.com/spacebarchat/docs.git synced 2024-11-09 20:02:32 +01:00

Go to file

TheArcaneBrony 3bb67a3987 Fix workflow		2023-05-01 12:24:58 +02:00
.github	Fix workflow	2023-05-01 12:24:58 +02:00
.vscode	Prettier!	2023-04-08 15:00:42 +10:00
docs	Add repo_dispatch and pulling of CoC	2023-05-01 12:23:28 +02:00
.gitignore	Add venv/ to .gitignore	2023-03-18 11:49:44 +01:00
.prettierrc	prettier	2023-01-02 20:13:12 +11:00
LICENSE	Update LICENSE	2021-05-14 15:01:32 +02:00
mkdocs.yml	use rapidoc for http api documentation	2023-04-28 22:26:57 +10:00
package.json	add package.json	2023-01-15 18:54:57 -05:00
README.md	Push Major Rebrand	2023-03-30 08:13:55 -06:00
requirements.txt	Add mkdocs-macros-plugin dependency	2023-03-19 12:21:42 +01:00

Spacebar Docs

How to get started

Clone the forked repository.

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

Install dependencies.

python3 -m pip install mkdocs-material mkdocs-swagger-ui-tag mkdocs-section-index mkdocs-macros-plugin

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.
Test locally.
- Serve in http://127.0.0.1:8000 with hot reload:
```
python3 -m mkdocs serve
```
- Build for production:
```
python3 -m mkdocs build
```
Commit changes with good commit messages.
Create a pull request.