Zum Hauptinhalt springen

Inhalte und Routen

Erfahre, wie Dateien ohne separate Routentabelle zu geordneten, lokalisierten Dokumentations-URLs werden.

Ginko Docs leitet Dokumentationsrouten aus der Docs-Collection ab. Ordner- und Dateinamen bestimmen die URL; numerische Präfixe bestimmen Reihenfolge und übersetzte Identität.

Einsprachige Inhalte

Wenn Englisch die einzige Sprache ist, liest defineGinkoDocsConfig() Markdown unter content/docs/ und stellt die Seiten unter /docs bereit.

  • content/docs
    • 1.getting-started
      • .navigation.yml
      • 1.index.md
      • 2.installation.md
    • 2.guides
      • 1.configuration.md

Die Dateien ergeben diese öffentlichen URLs:

QuelleURL
1.getting-started/1.index.md/docs/getting-started
1.getting-started/2.installation.md/docs/getting-started/installation
2.guides/1.configuration.md/docs/guides/configuration

Die Seite index.md belegt die URL ihres Ordners. Numerische Präfixe erscheinen in keinem öffentlichen Pfad.

Lokalisierte Inhalte

Trage beide Sprachen in der Content-Konfiguration ein, wenn englische und deutsche Seiten übersetzte Slugs verwenden:

content.config.ts
import { defineGinkoDocsConfig } from "@lupinum/ginko-docs/content";

export default defineGinkoDocsConfig({
  site: {
    name: "Acme Docs",
    description: "Documentation for Acme.",
    url: "https://docs.example.com",
  },
  locales: ["en", "de"],
  blog: false,
});

Diese Konfiguration erzeugt die lokalisierten Content-Routen. Nuxt i18n benötigt zusätzlich passende Locale-Einträge für Englisch und Deutsch; der Lokalisierungsleitfaden zeigt beide Konfigurationen gemeinsam.

Lege jede Sprache in einem eigenen Baum ab. Übersetze die lesbaren Namen, aber behalte für zusammengehörige Seiten dieselbe Kette numerischer Präfixe bei:

  • content
    • en/1.docs
      • 1.getting-started
        • 1.index.md
        • 2.installation.md
    • de/1.dokumentation
      • 1.erste-schritte
        • 1.index.md
        • 2.installation.md

1.docs/1.getting-started/2.installation.md und 1.dokumentation/1.erste-schritte/2.installation.md teilen eine übersetzte Identität. Sie ergeben /docs/getting-started/installation und /de/dokumentation/erste-schritte/installation.

Numerische Identitäten abgleichen
Wenn du ein numerisches Präfix nur in einer Sprache änderst, trennst du die Übersetzungen. Sortiere zusammengehörige Dateien und Ordner in allen Sprachen gemeinsam um.

Routenverhalten gehört zum Layer

Der Layer enthält bereits die Nuxt-Seiten für die englischen und deutschen Dokumentationspfade. Die Routen /docs und /de/dokumentation leiten jeweils auf die erste Seite ihres lokalisierten Baums weiter.

Wenn ein Projekt ein anderes Routenlayout benötigt, überschreibe die passende Nuxt-Seite über die normale Layer-Auflösung. Rufe keine interne Ginko-Docs-Routen-API auf; Konsumenten müssen kein öffentliches Routenregister pflegen.