From 359aec7b41baff55d200f06fe796ef6ff8c59136 Mon Sep 17 00:00:00 2001
From: Sebastian Frank <frank@basiskonfiguration.de>
Date: Sun, 10 Feb 2019 13:15:13 +0100
Subject: [PATCH] README.md

---
 README.md | 97 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 97 insertions(+)

diff --git a/README.md b/README.md
index e69de29..2f0bc77 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,97 @@
+# mark2web
+
+mark2web ist ein Website-Generator, der als Eingabe Markdown-Dateien, Templates und Konfigurations-Dateien nutzt.
+
+Die vorgesehene Arbeitsweise ist die Pflege der Inhalte über eine Versionsverwaltung (z.B. git) und anschließende CI/CD-Pipeline, welche den Generator aufruft und die fertige Website publiziert.
+
+## Verzeichnisstruktur der Quellen
+
+```plain
+DIR content
+    DIR de (Sprache)
+        DIR main (Navigationsbaum)
+            DIR 01_Home (1. Ebene)
+                FIL config.toml
+                FIL README.md
+            DIR 02_Download
+                FIL README.md
+            DIR 03_Kontakt
+                FIL README.md
+                DIR 01_Adresse
+                    FIL README.md
+                DIR 02_Anfahrt
+                    FIL README.md
+            DIR 04_Impressum
+                FIL README.md
+        service
+            DIR 01_Datenschutz
+                FIL README.md
+            DIR 02_AGB
+                FIL README.md
+            DIR 03_Impressum
+                FIL README.md
+DIR media
+    DIR Referenzbilder
+    DIR Mitarbeiterfotos
+
+DIR templates
+    DIR assets
+        DIR js
+        DIR img
+        DIR css
+    FIL home.tmpl
+    FIL site.tmpl
+    FIL TOP.tmpl
+    FIL BOTTOM.tmpl
+```
+
+### 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
+- zur Bildung des Navigationspfades werden die Verzeichnisnamen in Kleinschreibung konvertiert
+- Navigationsnamen für die Website werden aus dem Pfad gebildet, wobei `_`(Unterstriche) in Leerzeichen umgewandelt werden
+- Navigationsnamen können durch die `config.toml` überschrieben werden
+
+### media
+
+- enthält alle Bilder, Videos und andere Medien-Dateien, die via Markdown in die jeweiligen Websites eingebunden werden
+- Bilder die im Template benötigt werden liegen in `templates/assets`
+
+### templates
+
+- Template-Dateien für die Generierung der Website liegen hier
+- assets wie Bilder, JS, CSS sollten ebenfalls hier liegen
+
+## Einzelseiten
+
+Jede Seite ist innerhalb der Ordnerstruktur (Navigation) standardmäßig als `README.md` gespeichert. Die Datei ist eine normale Markdown-Datei mit einem optionalen Header:
+
+```markdown
+---
+meta:
+    title: Seitentitel für die Meta-Angaben
+    keywords: Meta-Keywords
+    description: Meta-Description
+
+---
+
+# Seitentitel
+
+Seiteninhalt, lorem ipsum...
+
+## Überschrift 2
+
+Weiterer Absatz, usw...
+```
+
+## zusätzliche Konfiguration
+
+In jedem Ordner kann sich eine `config.toml` befinden.
+
+- z.B. Verküpfung eines Eintrags eines Navigations-Baums zu einem anderen
+
+```toml
+goto=/de/main/service/impressum
+navname=Impressum
+```