Tiramisu Docs

Configuration

Internationalisierung

Richten Sie mehrsprachige Dokumentation mit Ordnerstruktur, Fallback und Sprachwechsler ein.

Internationalisierung (i18n)

Tiramisu Docs unterstützt mehrere Sprachen von Haus aus. Jede Sprache erhält ihren eigenen Ordner, und das Framework kümmert sich um Routing, Fallback und Sprachwechsel.

Konfiguration

Fügen Sie einen i18n-Block zu Ihrer Konfiguration hinzu:

typescript 
i18n: {
  defaultLocale: "en",
  locales: [
    { code: "en", label: "English", flag: "🇬🇧" },
    { code: "fr", label: "Français", flag: "🇫🇷" },
    { code: "de", label: "Deutsch", flag: "🇩🇪" },
  ],
},

Ordnerstruktur

Jede Sprache hat ihren eigenen Ordner innerhalb von src/docs/:

src/docs
en
getting-started.tiramisu
guide.tiramisu
fr
getting-started.tiramisu
guide.tiramisu
de
getting-started.tiramisu

Jeder Ordner (en, fr, de) entspricht einem Sprachcode aus Ihrer Konfiguration.

URL-Struktur

Seiten werden unter ihrem Sprach-Präfix bereitgestellt:

  • /docs/getting-started — Englische Version
  • /docs/fr/getting-started — Französische Version
  • /docs/de/getting-started — Deutsche Version

Fallback-Verhalten

Wenn eine Seite in der ausgewählten Sprache nicht existiert, greift Tiramisu Docs auf die Standardsprache zurück und zeigt ein Banner an, das darauf hinweist, dass die Seite in der ausgewählten Sprache nicht verfügbar ist.

Sprachwechsler

Wenn mehrere Sprachen konfiguriert sind, erscheint ein Sprachwechsler in der Seitenleiste. Benutzer können die Sprache wechseln, und das Framework navigiert zur entsprechenden Seite in der ausgewählten Sprache.