2019-12-14 17:59:34 +00:00
|
|
|
# Ctdo Homepage
|
2019-12-11 19:02:42 +00:00
|
|
|
|
2019-12-17 21:12:50 +00:00
|
|
|
## Selbst bauen
|
|
|
|
|
|
|
|
|
|
Um das Projekt zu bauen, oder lokal daran zu entwickeln musst du `nodejs` und `yarn` installiert
|
2019-12-17 22:59:33 +00:00
|
|
|
haben. Falls du das eher möchtest, `npm` geht auch.
|
2019-12-17 21:12:50 +00:00
|
|
|
|
|
|
|
|
Um die Dependencies zu installieren führe einmal im Projektverzeichnis `yarn` aus.
|
2019-12-17 22:59:33 +00:00
|
|
|
|
2019-12-17 21:12:50 +00:00
|
|
|
Um die Webseite lokal zu testen führe danach `yarn develop` aus.
|
2019-12-17 22:59:33 +00:00
|
|
|
Es startet dann ein Entwicklungsserver auf `localhost:8000`.
|
|
|
|
|
Dann sollte auch Hot-Reloading funktionieren (tut es aber aktuell u.U. nicht, mecker neri an).
|
|
|
|
|
|
|
|
|
|
Für einen Produktivbuild führe `yarn build` aus.
|
|
|
|
|
Die fertig gebauten Dateien landen dann im Ordner `public/`.
|
2019-12-17 21:12:50 +00:00
|
|
|
|
2019-12-14 17:59:34 +00:00
|
|
|
## Eine Seite bearbeiten
|
2019-12-11 19:02:42 +00:00
|
|
|
|
2019-12-14 17:59:34 +00:00
|
|
|
Klicke bei der Seite, die du bearbeiten möchtest unten im Footer auf "Seite bearbeiten".
|
|
|
|
|
Nimm im Editor der sich öffnet die gewünschten Änderungen vor.
|
|
|
|
|
Wie die Seiten aufgebaut sind steht unten in der Sektion Seitenlayout.
|
|
|
|
|
Wie du deine Änderung veröffentlichst steht in der Sektion Deploy.
|
2019-12-11 19:02:42 +00:00
|
|
|
|
2019-12-14 17:59:34 +00:00
|
|
|
## Eine neue Seite erstellen
|
2019-12-11 19:02:42 +00:00
|
|
|
|
2019-12-14 17:59:34 +00:00
|
|
|
Um eine neue Seite zu erstellen lege eine neue Datei im `markdown-pages` Ordner
|
|
|
|
|
[hier](https://repos.ctdo.de/-/ide/project/neri/ctdo-hompage/tree/master/-/src/markdown-pages/) an.
|
|
|
|
|
Wie die Seite aufgebaut sein muss steht unten in der Sektion Seitenlayout.
|
|
|
|
|
Wie du deine Änderung veröffentlichst steht in der Sektion Deploy.
|
2019-12-11 19:02:42 +00:00
|
|
|
|
2019-12-14 17:59:34 +00:00
|
|
|
Um die neue Seite in die Navigation einzubinden füge ein neues Element in das Array `pages` in
|
|
|
|
|
[diese Datei](https://repos.ctdo.de/-/ide/project/neri/ctdo-hompage/blob/master/-/src/components/nav.js)
|
|
|
|
|
ein.
|
2019-12-11 19:02:42 +00:00
|
|
|
|
2019-12-14 17:59:34 +00:00
|
|
|
## Seitenlayout
|
2019-12-11 19:02:42 +00:00
|
|
|
|
2019-12-14 17:59:34 +00:00
|
|
|
Eine Seite muss mit folgendem Header beginnen:
|
2019-12-17 21:12:50 +00:00
|
|
|
|
2019-12-14 17:59:34 +00:00
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
path: ""
|
|
|
|
|
title: ""
|
|
|
|
|
edit: ""
|
|
|
|
|
---
|
|
|
|
|
```
|
2019-12-17 21:12:50 +00:00
|
|
|
|
2019-12-14 17:59:34 +00:00
|
|
|
In `path` muss stehen, unter welchem Pfad die Seite auf der Webseite erscheint.
|
|
|
|
|
Für die Home-Seite ist dies beispielsweise "/", für die "Zeiten & Location"-Seite "/treff".
|
|
|
|
|
In `title` steht der Text der im Browsertab angezeigt werden soll wenn die Seite offen ist.
|
|
|
|
|
In `edit` muss der Name der angelegten Datei stehen, dieser wird verwendet,
|
|
|
|
|
damit der "Seite bearbeiten"-Link richtig funktioniert.
|
2019-12-11 19:02:42 +00:00
|
|
|
|
2019-12-14 17:59:34 +00:00
|
|
|
Darunter wird die Seite in [Markdown](https://www.markdownguide.org/cheat-sheet/) definiert.
|
|
|
|
|
Als Konvention werden auf der Seite keine `H1`, sondern erst `H2`-Überschriften verwendet.
|
2019-12-11 19:02:42 +00:00
|
|
|
|
2019-12-14 17:59:34 +00:00
|
|
|
## Deploy
|
2019-12-11 19:02:42 +00:00
|
|
|
|
2019-12-14 17:59:34 +00:00
|
|
|
Wenn du mit deinen Änderungen fertig bist,
|
|
|
|
|
klicke auf Commit und gib eine Beschreibung deiner Änderungen ein.
|
|
|
|
|
Ungefähr 30 Sekunden später sollten deine Änderungen auf der Website sichtbar sein.
|
|
|
|
|
Möglicherweise musst du einmal mit Shift+F5 deinen Browsercache ignorieren.
|
