Tiramisu Docs

Configuration

Sections

Divisez votre documentation en sections avec onglets de navigation, liens externes et menus déroulants.

Les sections vous permettent de diviser votre documentation en zones distinctes de premier niveau. Chaque section apparaît sous forme d'onglet dans la barre de navigation et dispose de sa propre barre latérale.

Définir des sections

Ajoutez un tableau sections à votre configuration. Chaque section nécessite un label (nom affiché) et un path (nom du dossier dans votre répertoire de documentation) :

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

Avec cette configuration, la structure de votre dossier de documentation devrait ressembler à ceci :

src/docs
framework
getting-started
writing
language
basics
internals

Chaque nom de dossier correspond à la valeur path de la configuration de votre section.

Fonctionnement des sections

Chaque section correspond à un sous-dossier dans votre répertoire de documentation. Lorsqu'un utilisateur clique sur un onglet de section dans la barre de navigation, la barre latérale se met à jour pour afficher uniquement les pages de cette section.

Liens externes

Vous pouvez également ajouter des sections qui renvoient vers des URL externes en utilisant href au lieu de path :

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

Sections déroulantes

Les sections peuvent avoir des éléments enfants pour les menus déroulants :

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