diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..5df254b --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,5 @@ +{ + "files.associations": { + "*.html": "handlebars" + } +} \ No newline at end of file diff --git a/README.md b/README.md index 029876d..e3117f1 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ Die vorgesehene Arbeitsweise ist die Pflege der Inhalte über eine Versionsverwa ```plain DIR content + FIL config.yml (Pfad-Konfiguration) DIR de (Sprache) DIR main (Navigationsbaum) DIR 01_Home (1. Ebene) @@ -15,6 +16,8 @@ DIR content FIL README.md DIR 02_Download FIL README.md + FIL bild.jpg + FIL presse.zip DIR 03_Kontakt FIL README.md DIR 01_Adresse @@ -30,9 +33,6 @@ DIR content FIL README.md DIR 03_Impressum FIL README.md -DIR media - DIR Referenzbilder - DIR Mitarbeiterfotos DIR assets DIR js @@ -40,12 +40,14 @@ DIR assets DIR css DIR templates - FIL home.tmpl - FIL site.tmpl - FIL TOP.tmpl - FIL BOTTOM.tmpl + FIL home.html + FIL site.html + DIR partials + FIL meta.html + FIL header.html + FIL footer.html -FIL config.yml +FIL config.yml (globale Konfiguration, enthält andere Anweisungen als individuelle Pfad-Konfig, siehe Beispiel) ``` ### content @@ -56,16 +58,18 @@ FIL config.yml - Navigationsnamen für die Website werden aus dem Pfad gebildet, wobei `_`(Unterstriche) in Leerzeichen umgewandelt werden - Navigationsnamen können durch die `config.yml` überschrieben werden -### media +### Medien und Downloads -- enthält alle Bilder, Videos und andere Medien-Dateien, die via Markdown in die jeweiligen Websites eingebunden werden -- außerdem können die Mediendateien auch neben den Inhalten in `content` liegen und müssen demensprechend relativ verlinkt werden -- Bilder die im Template benötigt werden liegen in `assets` +- Mediendateien werden neben den Inhalten in `content` abgelegt und müssen dementsprechend relativ verlinkt werden + +### assets + +- Bilder/CSS/JS die im Templates benötigt werden liegen in `assets` ### templates - Template-Dateien für die Generierung der Website liegen hier -- assets wie Bilder, JS, CSS sollten ebenfalls hier liegen +- Handlebar-Partials liegen in `templates/partials` und werden von mark2web global eingelesen und in Templates unter dem Dateinamen zur Verfügung gestellt ## Einzelseiten @@ -73,10 +77,13 @@ Jede Seite ist innerhalb der Ordnerstruktur (Navigation) standardmäßig als `RE ```markdown --- -meta: - title: Seitentitel für die Meta-Angaben - keywords: Meta-Keywords - description: Meta-Description +Meta: + Title: Seitentitel für die Meta-Angaben + Keywords: Meta-Keywords + Description: Meta-Description + +Data: + image: bild.jpg --- @@ -96,8 +103,8 @@ 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 +GoTo: /de/main/service/impressum +Navname: Impressum ``` - außerdem kann sich im Header der Markdown-Datei die Konfig im YAML-Format befinden @@ -106,12 +113,12 @@ navname: Impressum ## Haupt-Konfiguration im Root ```yml -meta: - title: meine Website - description: Standard-Meta-Beschreibung, die verwendet wird, wenn keine pro Seite definiert ist - keywords: Standard-Keywords, welche in den einzelnen Seiten überschrieben werden kann +Meta: + Title: meine Website + Description: Standard-Meta-Beschreibung, die verwendet wird, wenn keine pro Seite definiert ist + Keywords: Standard-Keywords, welche in den einzelnen Seiten überschrieben werden kann ``` ## Templates -Die Template sind golang `template/html`. \ No newline at end of file +Die Template-Sprache ist Handlebars. \ No newline at end of file diff --git a/example/content/de/main/03_kontakt/01_adresse/README.md b/example/content/de/main/03_kontakt/01_adresse/README.md index a80ab4b..3441343 100644 --- a/example/content/de/main/03_kontakt/01_adresse/README.md +++ b/example/content/de/main/03_kontakt/01_adresse/README.md @@ -6,4 +6,6 @@ Meta: # Adresse -Lorem ipsum... \ No newline at end of file +Lorem ipsum... + +![mein Bild](bild.jpg) diff --git a/example/content/de/main/03_kontakt/01_adresse/bild.jpg b/example/content/de/main/03_kontakt/01_adresse/bild.jpg new file mode 100644 index 0000000..80a2689 Binary files /dev/null and b/example/content/de/main/03_kontakt/01_adresse/bild.jpg differ diff --git a/example/content/de/main/03_kontakt/02_anfahrt/README.md b/example/content/de/main/03_kontakt/02_anfahrt/README.md index e355a1d..3de9ec4 100644 --- a/example/content/de/main/03_kontakt/02_anfahrt/README.md +++ b/example/content/de/main/03_kontakt/02_anfahrt/README.md @@ -6,4 +6,6 @@ Meta: # Anfahrt -Lorem ipsum... \ No newline at end of file +Lorem ipsum... + +