mirror of https://github.com/spacebarchat/docs.git synced 2024-11-08 11:22:31 +01:00

Go to file

Puyodead1 7596405aa9 add package.json		2023-01-15 18:54:57 -05:00
.github	update workflow	2023-01-11 00:29:03 +11:00
.vscode	prettier	2023-01-02 20:13:12 +11:00
docs	no extension for typeorm migration generation	2023-01-16 00:00:08 +11:00
.gitignore	added newline at the end of file	2021-10-14 19:46:34 +09:00
.prettierrc	prettier	2023-01-02 20:13:12 +11:00
LICENSE	Update LICENSE	2021-05-14 15:01:32 +02:00
mkdocs.yml	update site description	2023-01-07 23:40:57 +11:00
package.json	add package.json	2023-01-15 18:54:57 -05:00
README.md	Forgot to update readme	2023-01-07 13:08:40 +11:00
requirements.txt	add requirements.txt	2023-01-15 18:52:37 -05:00

Fosscord Docs

How to get started:

Clone the forked repository.

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

Install dependencies.

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

Edit documents(s).
- Format document(s).
fosscord 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.