read config
This commit is contained in:
42
README.md
42
README.md
@@ -11,7 +11,7 @@ DIR content
|
||||
DIR de (Sprache)
|
||||
DIR main (Navigationsbaum)
|
||||
DIR 01_Home (1. Ebene)
|
||||
FIL config.toml
|
||||
FIL config.yml
|
||||
FIL README.md
|
||||
DIR 02_Download
|
||||
FIL README.md
|
||||
@@ -34,17 +34,18 @@ DIR media
|
||||
DIR Referenzbilder
|
||||
DIR Mitarbeiterfotos
|
||||
|
||||
DIR assets
|
||||
DIR js
|
||||
DIR img
|
||||
DIR css
|
||||
|
||||
DIR templates
|
||||
DIR assets
|
||||
DIR js
|
||||
DIR img
|
||||
DIR css
|
||||
FIL home.tmpl
|
||||
FIL site.tmpl
|
||||
FIL TOP.tmpl
|
||||
FIL BOTTOM.tmpl
|
||||
|
||||
FIL config.toml
|
||||
FIL config.yml
|
||||
```
|
||||
|
||||
### content
|
||||
@@ -53,12 +54,13 @@ FIL config.toml
|
||||
- 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
|
||||
- Navigationsnamen können durch die `config.yml` ü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`
|
||||
- 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`
|
||||
|
||||
### templates
|
||||
|
||||
@@ -89,25 +91,25 @@ Weiterer Absatz, usw...
|
||||
|
||||
## zusätzliche Konfiguration
|
||||
|
||||
In jedem Ordner kann sich eine `config.toml` befinden.
|
||||
In jedem Ordner kann sich eine `config.yml` befinden.
|
||||
|
||||
- z.B. Verküpfung eines Eintrags eines Navigations-Baums zu einem anderen
|
||||
|
||||
```toml
|
||||
goto=/de/main/service/impressum
|
||||
navname=Impressum
|
||||
```yml
|
||||
goto: /de/main/service/impressum
|
||||
navname: Impressum
|
||||
```
|
||||
|
||||
- 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
|
||||
|
||||
```toml
|
||||
[global]
|
||||
default_file=README.md
|
||||
|
||||
[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
|
||||
```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
|
||||
```
|
||||
|
||||
## Templates
|
||||
|
||||
Reference in New Issue
Block a user