From aeb7517473cfe4fc475ae6857a33786017907715 Mon Sep 17 00:00:00 2001 From: Sebastian Frank Date: Wed, 13 Feb 2019 21:16:35 +0100 Subject: [PATCH] fixed README --- README.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e3117f1..a92f5bd 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ DIR templates FIL config.yml (globale Konfiguration, enthält andere Anweisungen als individuelle Pfad-Konfig, siehe Beispiel) ``` -### content +### `content` - enthält die Markdown-Dateien und Konfigurationen für die Navigationsstruktur und Einzelseiten - voranestellte Nummer mit Unterstrich wie z.B. `01_` dienen nur der Sortierung und gehen nicht in den eigentlichen Navigationspfad mit ein @@ -62,11 +62,11 @@ FIL config.yml (globale Konfiguration, enthält andere Anweisungen als individue - Mediendateien werden neben den Inhalten in `content` abgelegt und müssen dementsprechend relativ verlinkt werden -### assets +### `assets` - Bilder/CSS/JS die im Templates benötigt werden liegen in `assets` -### templates +### `templates` - Template-Dateien für die Generierung der Website liegen hier - Handlebar-Partials liegen in `templates/partials` und werden von mark2web global eingelesen und in Templates unter dem Dateinamen zur Verfügung gestellt @@ -82,7 +82,7 @@ Meta: Keywords: Meta-Keywords Description: Meta-Description -Data: +Data: # Vererbung spielt hier keine Rolle, da Markdown-Datei letzte Ebene in der Generierung ist image: bild.jpg --- @@ -103,14 +103,21 @@ In jedem Ordner kann sich eine `config.yml` befinden. - z.B. Verküpfung eines Eintrags eines Navigations-Baums zu einem anderen ```yml -GoTo: /de/main/service/impressum -Navname: Impressum +This: + GoTo: /de/main/service/impressum + Navname: Impressum + + Data: # wird nicht vererbt: {{ NavSlice.[0].This.Data.slogan }} + slogan: Rechtliches und mehr + +Data: # wird an alle Unterpunkte vererbt: {{ NavSlice.[0].Data.slogan }} + image: imprint.png ``` - außerdem kann sich im Header der Markdown-Datei die Konfig im YAML-Format befinden - die Konfig in der Markdown-Datei überschreibt die Konfig aus der config.yml -## Haupt-Konfiguration im Root +## Haupt-Konfiguration im `content`-Verzeichnis ```yml Meta: @@ -121,4 +128,8 @@ Meta: ## Templates -Die Template-Sprache ist Handlebars. \ No newline at end of file +Die Template-Sprache ist Handlebars. + +### Helper + +Weitere Handlebars-Helper sind: \ No newline at end of file