Spacebar/docs
1
0
Fork 0
mirror of https://github.com/spacebarchat/docs.git synced 2024-11-22 10:12:31 +01:00
Code Issues Releases Activity
Mirror of https://github.com/spacebarchat/docs
147 Commits 6 Branches 0 Tags 11 MiB
Text 100%
8c9de4315a
Go to file
Samuel 8c9de4315a
Merge pull request #11 from developomp/master 
My first contribution to fosscord
2021-10-16 21:09:24 +02:00
.github 🐛 fix build workflow 2021-10-09 12:07:38 +02:00
docs Merge pull request #11 from developomp/master 2021-10-16 21:09:24 +02: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 makd it easier to start contributing 2021-10-14 20:01:40 +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-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.