mark2web/website/content/de/01_Navigation/03_Benutzung/01_Ordnerstruktur
Sebastian Frank 70d7497eda
All checks were successful
continuous-integration/drone/push Build is passing
better project layout
2019-03-19 11:15:32 +01:00
..
config.yml better project layout 2019-03-19 11:15:32 +01:00
README.md better project layout 2019-03-19 11:15:32 +01:00

Data
background slider
/img/folder.jpg
img alt opacity
/img/folder.jpg 1

Benutzung

Ordnerstruktur

Das Ausgangsmaterial für die zu generierende Website wird in folgender Ordnerstruktur organisiert:

DIR content
    FIL config.yml (Pfad-Konfiguration)
    DIR de (Sprache)
        DIR main (Navigationsbaum)
            DIR 01_Home (1. Ebene)
                FIL config.yml
                FIL README.md
            DIR 02_Download
                FIL README.md
                FIL bild.jpg
                FIL presse.zip
            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 assets (kann auch abweichend benannt werden)
    DIR js
    DIR img
    DIR css

DIR templates
    DIR filters
        FILE myfilter.js
    FIL base.html
    FIL base_sub.html

FIL config.yml (globale Konfiguration, enthält andere Anweisungen als individuelle Pfad-Konfig, siehe Beispiel)

In der Minimal-Variante sind nur die Ordner content und templates nötig.


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.yml überschrieben werden

Medien und Downloads

  • Mediendateien werden neben den Inhalten in content abgelegt und müssen dementsprechend relativ verlinkt werden

assets

  • Bilder/CSS/JS die in Templates oder mehrfach in den Content-Seiten benötigt werden liegen in assets

templates

  • Template-Dateien für die Generierung der Website liegen hier