Spacebar/docs
1
0
Fork 0
mirror of https://github.com/spacebarchat/docs.git synced 2024-11-25 03:33:05 +01:00
Code Issues Releases Activity
Mirror of https://github.com/spacebarchat/docs
293 Commits 6 Branches 0 Tags 11 MiB
Text 100%
c160b918b2
Go to file
Madeline c160b918b2
Merge pull request #46 from fosscord/add/maintenance 
* Moves updating guide -> maintenance
* Adds `when should server restart` page. Inspired by this question: https://discord.com/channels/806142446094385153/898197424340860928/1062927020750802985
2023-01-12 23:54:18 +11:00
.github update workflow 2023-01-11 00:29:03 +11:00
.vscode prettier 2023-01-02 20:13:12 +11:00
docs Merge pull request #46 from fosscord/add/maintenance 2023-01-12 23:54:18 +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
README.md Forgot to update readme 2023-01-07 13:08:40 +11:00

README.md

Fosscord Docs

Build to GitHub Pages code style: prettier

How to get started:

  1. Fork this repository.

  2. Clone the forked repository.

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

  3. Install dependencies.

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

  4. 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.

  5. Test locally.

    • Serve in http://127.0.0.1:8000 with hot reload:

      python3 -m mkdocs serve

    • Build for production:

      python3 -m mkdocs build

  6. Commit changes with good commit messages.

  7. Create a pull request.