Spacebar/docs
1
0
Fork 0
mirror of https://github.com/spacebarchat/docs.git synced 2024-11-22 18:22:31 +01:00
Code Issues Releases Activity
Mirror of https://github.com/spacebarchat/docs
335 Commits 6 Branches 0 Tags 11 MiB
Text 100%
6b21458e74
Go to file
Florian Weber 6b21458e74
Add client-questions to FAQ
2023-03-18 11:53:24 +01:00
.github update workflow 2023-01-11 00:29:03 +11:00
.vscode prettier 2023-01-02 20:13:12 +11:00
docs Add client-questions to FAQ 2023-03-18 11:53:24 +01: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 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 add deploy button to readme 2023-01-15 19:01:33 -05:00
requirements.txt add requirements.txt 2023-01-15 18:52:37 -05:00

README.md

Fosscord Docs

Build to GitHub Pages code style: prettier

Deploy with Vercel

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.