SmashGrade / SmashGrade-App

https://www.smashgrade.ch
3 stars 0 forks source link

Wiki evaluieren #61

Open joshua-lehmann opened 11 months ago

joshua-lehmann commented 11 months ago

Welches Wiki kann zur Dokumentation verwendet werden Mögliche Tools:

joshua-lehmann commented 11 months ago

Created a sample documentation with Docusaurus, Doctave and MkDocs in my GitHub:

All Of them are deployed to GitHub Pages:

I would suggest to use either MkDocs or Docusaurus. MkDocs uses only markdown, and is built/deployed with a simple Python command is hast a good amount of features but is super basic/simple Docusaurus uses MDX (Markdown + JSX) but can also only use simple markdown, has a lot of features and configuration possiblilties and is also kind of the standard for bigger project documentation like: https://ionicframework.com/docs or https://docsearch.algolia.com/ Hower it is a NPM Project with dependencies and config files and uses npm to buil/run locally. So it is a bit more complex than MkDocs because of more features and configuration and bigger project structure.

joshua-lehmann commented 11 months ago

Es wurde sich für Material for MK Docs entschieden und das Doku repo erstellt: https://github.com/SmashGrade/Documentation