mambax
commented
3 years ago Hallo @bebot91
Klar, es gibt viele Möglichkeiten!
Die einfachste ist einfach Markdown Files zu schreiben (.md). Das ist aber weniger Interaktiv. Dann gibt es einfach statische Seiten oder Komplexe.
Ich verwende hier, im SWD (für diese Docs hier), und bei SAP https://docusaurus.io/. Es ist schnell aufgesetzt und deployt mit GitHub Actions (Actions schauen wir in den nächsten Lektionen an).
GitHub selbst hat mit den Pages nur eines am Hut: Man kann pro Repository 1 statische Seite hosten, sogenannte Pages: https://pages.github.com/
Auf diesen Pages kann man eine statische Website hosten, ich hoste darauf das Build-Resultat von Docusaurus (was eine statische Seite ist).
Für die MA kann ich docusaurus empfehlen.
Es gibt aber auch zB:
- https://gohugo.io/
- https://getdoks.org/ (nutzt auch Hugo "under the Hood")
- https://jekyllrb.com/docs/ (von GitHub selber)
- dutzende wenn nicht hunderte Andere
Hier kann man wieder wählen (wie immer 🤣 ), Docusaurus hat am meisten ⭐️ auf GH und eine super Community.
Hilft dir das mal für die ersten Schritte?
Hallo Dominik
Du erwähntest im Unterricht falls Interessen betreffend neuer Dokumentationstools / Möglichkeiten vorhanden wären, könnte man sich kurz bei Dir melden. Ich fände es interessant den Grossteil der Doku interaktiv zu gestalten oder ggf. eine Form von kleinerem Wiki zum entstehenden Produkt (MA 2) zu ertsellen.
Kenne da aber die Möglichkeiten mit github nicht... Hast Du da ggf. Beispiele?
Danke + Gruess Reto