updated README
All checks were successful
publish / publish (push) Successful in 25s

This commit is contained in:
Jannik Menzel 2025-06-26 15:03:03 +02:00
parent 6910815ec1
commit 745fb82ec0
4 changed files with 30 additions and 17 deletions

View file

@ -10,6 +10,7 @@ Informationsplattform für Studierende der Fakultät Informatik.
- **Framework:** [Hugo](https://gohugo.io/) statischer Site-Generator
- **CSS-Framework:** [Bootstrap](https://getbootstrap.com/) responsives Frontend-Toolkit
- **Decap-CMS:** [Decap](https://decapcms.org/) Content-Management-System
## 🚀 Schnellstart
@ -47,12 +48,12 @@ Anschließend kannst du die Website im Browser unter [http://localhost:1313](htt
- `layouts/` Individuelle Layouts und Templates
- `static/` Statische Dateien (z.B. Bilder, PDFs)
- `assets/` CSS, JavaScript Dateien und Images
- `data/` Navigation Config-Datei
- `data/` Navigation und Config-Dateien
- `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.
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
@ -62,25 +63,24 @@ Das CMS ist unter `/admin` erreichbar: [https://ifsr.de/admin](https://ifsr.de/a
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").
3. Wähle in der linken Navigation die gewünschte Inhaltskategorie (z.B. "About").
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".
5. Nimm Änderungen im Editor vor und speichere sie mit "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.
- Das CMS spiegelt die Navigation basierend auf den vorhandenen Inhalten und Konfigurationen wider. Achte daher darauf, dass Änderungen sowohl im `GER` als auch im `ENG` Verzeichnis durchgeführt werden.
- Für neue Inhaltstypen oder angepasste Nav-Strukturen 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.:
1. Erstelle neue Markdown-Dateien (.de und .en für Mehrsprachigkeit) innerhalb von `content/`, z.B.:
```bash
content/about/team.md
```
- `content/team.de.md`
- `content/team.en.md`
2. Füge in der Datei ein Front-Matter hinzu:
@ -92,7 +92,7 @@ Das CMS ist unter `/admin` erreichbar: [https://ifsr.de/admin](https://ifsr.de/a
---
```
3. Trage die Seite in der Navigationsstruktur ein, indem du sie in `data/navigation.toml` ergänzt:
3. Trage die Seite in der Navigationsstruktur ein, indem du sie in `navigation_de.toml` und `navigation_en.toml` ergänzt:
```toml
[[menu.main]]
@ -117,7 +117,7 @@ Das CMS ist unter `/admin` erreichbar: [https://ifsr.de/admin](https://ifsr.de/a
1. Öffne die entsprechende `.md`-Datei im `content/`-Verzeichnis.
2. Bearbeite den Inhalt im Markdown-Format.
3. Änderungen werden beim Speichern durch `hugodev` automatisch neu geladen.
3. Änderungen werden durch `hugodev` automatisch neu geladen.
---
@ -126,6 +126,14 @@ Das CMS ist unter `/admin` erreichbar: [https://ifsr.de/admin](https://ifsr.de/a
Du kannst Code Snippets in deine Markdown Files integrieren, um die Website interaktiver zu gestalten. Nachfolgend
findest du hierfür eine Anleitung.
#### Image
```
{{< image
src="/images/picture.jpg"
alt="Alt Text" >}}
```
#### Details
![cover.png](static/docs/details.png)
@ -146,11 +154,7 @@ number="01" >}}
```
{{< profile
name="Name"
image="/images/mitglieder/vorname-nachname.jpg"
studiengang="BA Informatik, 1. Semester" >}}
{{ .Content }}
bio="vorname-nachname" >}}
{{< /profile >}}
```