Spacebar/docs
1
0
Fork 0
mirror of https://github.com/spacebarchat/docs.git synced 2024-09-19 23:21:40 +02:00
Code Issues Releases Activity
Mirror of https://github.com/spacebarchat/docs
150 Commits 6 Branches 0 Tags 11 MiB
Text 100%
4b379cc822
Go to file
developomp 4b379cc822 fixed packages in build workflow and documentation being different
2021-10-17 09:45:10 +09:00
.github fixed packages in build workflow and documentation being different 2021-10-17 09:45:10 +09:00
docs Nothing is perfect 2021-10-16 22:21:24 +03:00
.gitignore added newline at the end of file 2021-10-14 19:46:34 +09:00
LICENSE Update LICENSE 2021-05-14 15:01:32 +02:00
mkdocs.yml 🎨 restructure 2021-10-09 00:48:23 +02:00
README.md fixed packages in build workflow and documentation being different 2021-10-17 09:45:10 +09: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-render-swagger-plugin mkdocs-section-index

  4. Test locally.

    • development:

      python3 -m mkdocs serve

    • production:

      python3 -m mkdocs build

  5. Edit documents(s).

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

  7. Commit changes with good commit messages.

  8. Create a pull request.