Tiramisu Docs

Configuration

Sektionen

Teilen Sie Ihre Dokumentation in separate Bereiche mit eigenen Tabs und Seitenleisten auf.

Sektionen ermöglichen es Ihnen, Ihre Dokumentation in separate Bereiche auf oberster Ebene aufzuteilen. Jede Sektion erscheint als Tab in der Navigationsleiste und erhält eine eigene Seitenleiste.

Sektionen definieren

Fügen Sie ein sections-Array zu Ihrer Konfiguration hinzu. Jede Sektion benötigt ein label (Anzeigename) und einen path (Ordnername in Ihrem Docs-Verzeichnis):

typescript 
sections: [
  { label: "Framework", path: "framework" },
  { label: "Language", path: "language" },
],

Mit dieser Konfiguration sollte Ihre Ordnerstruktur wie folgt aussehen:

src/docs
framework
getting-started
writing
language
basics
internals

Jeder Ordnername entspricht dem path-Wert aus Ihrer Sektionskonfiguration.

Wie Sektionen funktionieren

Jede Sektion ist einem Unterordner in Ihrem Docs-Verzeichnis zugeordnet. Wenn ein Benutzer auf einen Sektions-Tab in der Navigationsleiste klickt, wird die Seitenleiste aktualisiert und zeigt nur die Seiten innerhalb dieser Sektion an.

Sie können auch Sektionen hinzufügen, die auf externe URLs verlinken, indem Sie href anstelle von path verwenden:

typescript 
sections: [
  { label: "Guide", path: "guide" },
  { label: "GitHub", href: "https://github.com/user/repo" },
],

Sektionen können Unterelemente für Dropdown-Menüs haben:

typescript 
sections: [
  {
    label: "Resources",
    children: [
      { label: "Blog", href: "https://blog.example.com" },
      { label: "Changelog", href: "/changelog" },
    ],
  },
],