changed README
All checks were successful
publish / publish (push) Successful in 26s

This commit is contained in:
Jannik Menzel 2025-05-29 19:59:08 +02:00
parent e22c7789fa
commit aebd0828ad

View file

@ -2,7 +2,9 @@
# iFSR Website TU Dresden
Dies ist die offizielle Website des iFSR (Informatik-Fachschaftsrat) der Technischen Universität Dresden. Die Seite wurde mit dem statischen Website-Generator [Hugo](https://gohugo.io/) erstellt und dient als zentrale Informationsplattform für Studierende der Fakultät Informatik.
Dies ist die offizielle Website des iFSR (Informatik-Fachschaftsrat) der Technischen Universität Dresden. Die Seite
wurde mit dem statischen Website-Generator [Hugo](https://gohugo.io/) erstellt und dient als zentrale
Informationsplattform für Studierende der Fakultät Informatik.
## 🔧 Technologien
@ -16,12 +18,14 @@ Dies ist die offizielle Website des iFSR (Informatik-Fachschaftsrat) der Technis
```bash
# macOS / Linux (mit Homebrew)
brew install hugo
```
```bash
# Windows (mit Chocolatey)
choco install hugo -y
```
Weitere Informationen: [https://gohugo.io/getting-started/installing/](https://gohugo.io/getting-started/installing/)
Weitere Informationen findest du [hier](https://gohugo.io/getting-started/installing/).
### Projekt klonen und lokal starten
@ -46,47 +50,66 @@ Anschließend kannst du die Website im Browser unter [http://localhost:1313](htt
- `data/` Navigation Config-Datei
- `hugo.toml` Hauptkonfigurationsdatei für Hugo
## 📝 CMS
Diese Website nutzt [Decap CMS](https://decapcms.org/) als Content Management System. Damit können berechtigte Nutzer:innen Inhalte direkt über eine grafische Oberfläche im Browser bearbeiten ganz ohne lokalen Zugriff oder technisches Vorwissen.
### Zugang zum CMS
Das CMS ist unter `/admin` erreichbar: [https://ifsr.de/admin](https://ifsr.de/admin). Die Anmeldung erfolgt über den Forgejo Account.
### Erste Schritte zur Bearbeitung
1. Rufe `/admin` im Browser auf.
2. Melde dich mit deinem Benutzerkonto an.
3. Wähle in der linken Navigation die gewünschte Inhaltskategorie (z.B. "Über Uns").
4. Klicke auf den Eintrag, den du bearbeiten möchtest.
5. Nimm Änderungen im Editor vor und speichere sie mit "Save" und anschließend "Publish".
### Hinweise
- Änderungen werden direkt im `content/` Verzeichnis gespeichert (als Markdown-Dateien im Git-Repository).
- Das CMS spiegelt die Navigation basierend auf den vorhandenen Inhalten und Konfigurationen wider.
- Für neue Inhaltstypen müssen ggf. Anpassungen an der Datei `static/admin/config.yml` vorgenommen werden.
## 💡 Entwicklungs-Hinweise
### Neue Seite anlegen (inkl. Navbar)
1. Erstelle eine neue Markdown-Datei im passenden Unterordner innerhalb von `content/`, z.B.:
```bash
content/about/team.md
```
```bash
content/about/team.md
```
2. Füge in der Datei ein Front-Matter hinzu:
```toml
+++
title = "Team"
+++
```
```markdown
---
title: "Title"
draft: false
url: /site/subsite/
---
```
3. Trage die Seite in der Navigationsstruktur ein, indem du sie in `data/navigation.toml` ergänzt:
```toml
[[menu.main]]
name = "Team"
url = "/about/team"
weight = 6
```
```toml
[[menu.main]]
name = "Team"
url = "/about/team"
weight = 6
```
4. Bei Bedarf kannst du durch Verschachtelung Unterseiten eines Menüpunkts einordnen:
```toml
[menu.[main]]
name = "Über uns"
url = "/about"
weight = 2
[[menu.main]]
parent = "Über uns"
name = "Team"
url = "/about/team"
weight = 6
```
```toml
[[menu.main]]
parent = "Team"
name = "Team Liste"
url = "/team/teamlist"
weight = 1
```
---
@ -100,7 +123,8 @@ Anschließend kannst du die Website im Browser unter [http://localhost:1313](htt
### Shortcode Snippets
Du kannst Code Snippets in deine Markdown Files integrieren, um die Website interaktiver zu gestalten. Nachfolgend findest du hierfür eine Anleitung.
Du kannst Code Snippets in deine Markdown Files integrieren, um die Website interaktiver zu gestalten. Nachfolgend
findest du hierfür eine Anleitung.
#### Details