Pfade

Pfade sind für LFP Docs von Eleventy verwaltet und standardmäßig verzeichnisorientiert. URLs der späteren Seiten orientieren sich also an der Ablagestruktur im Input-Verzeichnis.

Diese Seite setzt die folgenden Punkte voraus:

• config.baseUrl ist auf / gesetzt, die Seite ist also von der Domain Root aus erreichbar
• config.dir.input ist auf /docs gesetzt
• config.dir.output ist auf /_site gesetzt

Eleventy schreibt jedes Dokument als index.html in sein eigenes Unterverzeichnis, mit folgenden Vorzügen:

1. Server senden im Regelfall stets eine Datei mit Namen index.html zurück, wenn eine URL ohne Dateiendung angefragt wurde, weitere Konfigurationen sind also nicht notwendig.
2. Diese Vorgehensweise lässt zudem, ohne Konfiguration, valide Requests mit und ohne angehängtem / zu.

Implizites Routing

Wie eingangs beschrieben unterstützt Eleventy verzeichnisbasiertes Routing standardmäßig. Das bedeutet, dass der Inhalt des Input-Verzeichnisses mehr oder weniger identisch in das Output-Verzeichnis übernommen. Es besteht also kein Bedarf, für jede Seite einen individuellen Outputpfad zu definieren.

Ein beispielhaftes Verzeichnis könnte wie folgt aussehen:

.
└─ /docs
   ├─ /guide
   │  ├─ doc-1.md -> /guide/doc-1/index.html 
   │  └─ doc-2.md -> /guide/doc-2/index.html
   └─ /reference
      ├─ doc-3.md -> /reference/doc-3/index.html
      └─ doc-4.md -> /reference/doc-4/index.html

Siehe den Quelltext dieser Dokumentation für ein umfassenderes Beispiel.

Permalinks

Um dieses standardmäßige Verhalten zu überschreiben, bietet LFP Docs die Möglichkeit des permalink-Werts im Frontmatter einer Seite, mit dem ein individueller, vom Ablageort unabhängiger Pfad angegeben werden kann (dieser muss einzigartig sein!). Mehr Informationen sind im Nachschlagewerk zum Frontmatter und der Permalink-Dokumentation von Eleventy zu finden.

Während die Möglichkeit, Permalinks manuell selbst zu setzen, gegeben ist, wird dennoch empfohlen, zur Strukturierung von Dokumentationen verzeichnisorientiert vorzugehen und die resultiertenden Pfade von Eleventy festlegen zu lassen.