168 lines
4.6 KiB
Markdown
168 lines
4.6 KiB
Markdown
<img width="2140" alt="Homepage" src="https://github.com/user-attachments/assets/ffe7c42e-9345-467d-9fe9-852ea6818704" />
|
||
|
||
# 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.
|
||
|
||
## 🔧 Technologien
|
||
|
||
- **Framework:** [Hugo](https://gohugo.io/) – statischer Site-Generator
|
||
- **CSS-Framework:** [Bootstrap](https://getbootstrap.com/) – responsives Frontend-Toolkit
|
||
|
||
## 🚀 Schnellstart
|
||
|
||
### Hugo installieren
|
||
|
||
```bash
|
||
# macOS / Linux (mit Homebrew)
|
||
brew install hugo
|
||
```
|
||
|
||
```bash
|
||
# Windows (mit Chocolatey)
|
||
choco install hugo -y
|
||
```
|
||
|
||
Weitere Informationen findest du [hier](https://gohugo.io/getting-started/installing/).
|
||
|
||
### Projekt klonen und lokal starten
|
||
|
||
```bash
|
||
git clone git@github.com:jannikmenzel/iFSR-Website.git
|
||
cd iFSR-Website
|
||
|
||
# Alias für die lokale Entwicklungsumgebung
|
||
alias hugodev='hugo server --disableFastRender --ignoreCache --noHTTPCache --cleanDestinationDir'
|
||
|
||
hugodev
|
||
```
|
||
|
||
Anschließend kannst du die Website im Browser unter [http://localhost:1313](http://localhost:1313) aufrufen.
|
||
|
||
## 📁 Projektstruktur
|
||
|
||
- `content/` – Inhalte der Website (Seiten im Markdown Format)
|
||
- `layouts/` – Individuelle Layouts und Templates
|
||
- `static/` – Statische Dateien (z.B. Bilder, PDFs)
|
||
- `assets/` – CSS, JavaScript Dateien und Images
|
||
- `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
|
||
```
|
||
|
||
2. Füge in der Datei ein Front-Matter hinzu:
|
||
|
||
```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
|
||
```
|
||
|
||
4. Bei Bedarf kannst du durch Verschachtelung Unterseiten eines Menüpunkts einordnen:
|
||
|
||
```toml
|
||
[[menu.main]]
|
||
parent = "Team"
|
||
name = "Team Liste"
|
||
url = "/team/teamlist"
|
||
weight = 1
|
||
```
|
||
|
||
---
|
||
|
||
### Seite bearbeiten (Content/Markdown)
|
||
|
||
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.
|
||
|
||
---
|
||
|
||
### Shortcode Snippets
|
||
|
||
Du kannst Code Snippets in deine Markdown Files integrieren, um die Website interaktiver zu gestalten. Nachfolgend
|
||
findest du hierfür eine Anleitung.
|
||
|
||
#### Details
|
||
|
||
<img width="2140" alt="Details" src="https://github.com/user-attachments/assets/bb87179d-2ac8-4079-a6f5-4067cf9efee6" />
|
||
|
||
```
|
||
{{< details
|
||
title="Headline"
|
||
number="01" >}}
|
||
|
||
{{ content }}
|
||
|
||
{{< /details >}}
|
||
```
|
||
|
||
#### Profile
|
||
|
||
<img width="2070" alt="Profile" src="https://github.com/user-attachments/assets/e5966de3-7542-49dd-acd3-9d245a9ef358" />
|
||
|
||
```
|
||
{{< profile
|
||
name="Name"
|
||
image="/images/mitglieder/vorname-nachname.jpg"
|
||
studiengang="BA Informatik, 1. Semester"
|
||
email="vorname.nachname@ifsr.de" >}}
|
||
|
||
{{ content }}
|
||
|
||
{{< /profile >}}
|
||
```
|
||
|
||
## 📬 Kontakt
|
||
|
||
Bei Fragen oder Vorschlägen zur Website kontaktiere uns gerne:
|
||
|
||
- 📧 E-Mail: [fsr@ifsr.de](mailto:fsr@ifsr.de)
|
||
- 🌐 Website: [https://ifsr.de](https://ifsr.de)
|
||
|
||
Bei spezifischen Fragen zum Sourcecode kontaktiere:
|
||
|
||
- [jannik.menzel@ifsr.de](mailto:jannik.menzel@ifsr.de)
|