add instructions for developing
This commit is contained in:
parent
bd8fa6d1d7
commit
170fbbe0d2
13
README.md
13
README.md
|
@ -1,5 +1,15 @@
|
|||
# Ctdo Homepage
|
||||
|
||||
## Selbst bauen
|
||||
|
||||
Um das Projekt zu bauen, oder lokal daran zu entwickeln musst du `nodejs` und `yarn` installiert
|
||||
haben.
|
||||
|
||||
Um die Dependencies zu installieren führe einmal im Projektverzeichnis `yarn` aus.
|
||||
Um die Webseite lokal zu testen führe danach `yarn develop` aus.
|
||||
Für einen Produktivbuild `yarn build`.
|
||||
Die fertig gebauten Dateien landen dann im Ordner `public`.
|
||||
|
||||
## Eine Seite bearbeiten
|
||||
|
||||
Klicke bei der Seite, die du bearbeiten möchtest unten im Footer auf "Seite bearbeiten".
|
||||
|
@ -21,6 +31,7 @@ ein.
|
|||
## Seitenlayout
|
||||
|
||||
Eine Seite muss mit folgendem Header beginnen:
|
||||
|
||||
```
|
||||
---
|
||||
path: ""
|
||||
|
@ -28,6 +39,7 @@ title: ""
|
|||
edit: ""
|
||||
---
|
||||
```
|
||||
|
||||
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.
|
||||
|
@ -43,4 +55,3 @@ 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.
|
||||
|
||||
|
|
Loading…
Reference in New Issue