mirror of
https://github.com/spacebarchat/docs.git
synced 2024-11-12 13:22:33 +01:00
44 lines
1.3 KiB
Markdown
44 lines
1.3 KiB
Markdown
# Fosscord Docs
|
|
|
|
[](https://github.com/fosscord/fosscord-docs/actions/workflows/build.yml) [](https://github.com/prettier/prettier)
|
|
|
|
## How to get started:
|
|
|
|
1. Fork this repository.
|
|
2. Clone the forked repository.
|
|
|
|
```bash
|
|
git clone https://github.com/<YOUR_USERNAME_HERE>/fosscord-docs
|
|
```
|
|
|
|
3. Install dependencies.
|
|
|
|
```bash
|
|
python3 -m pip install mkdocs-material mkdocs-render-swagger-plugin mkdocs-section-index
|
|
```
|
|
|
|
4. Edit documents(s).
|
|
|
|
- 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).
|
|
|
|
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 http://127.0.0.1:8000 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.
|