Documentation multi-projet

Explainer permet de documenter plusieurs projets au sein d’un seul site de documentation. Chaque répertoire de premier niveau sous apps/docs/src/content/docs/ est traité comme un projet distinct.

Fonctionnement

apps/docs/src/content/docs/
├── explainer/           # Projet 1
│   ├── _meta.json
│   └── default/en/...
├── my-api/              # Projet 2
│   ├── _meta.json
│   └── default/en/...
└── cli-tool/            # Projet 3
    ├── _meta.json
    └── default/en/...

Chaque projet dispose de sa propre barre latérale, de son système de versionnement et de sa prise en charge des locales. Un sélecteur de projet apparaît dans la barre de navigation, permettant aux utilisateurs de passer d’un projet à l’autre.

_meta.json du projet

Chaque répertoire de projet doit inclure un fichier _meta.json :

my-api/_meta.json
{
  "icon": "lucide:server",
  "title": "My API"
}

Champ	Type	Description
`title`	`string`	Nom affiché dans le sélecteur de projet
`icon`	`string`	Icône affichée à côté du nom du projet

Ajouter un nouveau projet

Créer le répertoire du projet

mkdir -p apps/docs/src/content/docs/my-api/default/en

Ajouter le fichier _meta.json du projet

my-api/_meta.json
{
  "icon": "lucide:server",
  "title": "My API"
}

Créer votre première page

my-api/default/en/getting-started.mdx
---
title: Getting Started
description: Get started with My API.
order: 1
---

# Getting Started

Welcome to My API documentation.

Vérifier

Démarrez le serveur de développement et accédez à /en/my-api/getting-started. Le sélecteur de projet devrait maintenant lister les deux projets.

Structure des URL

Chaque projet possède son propre espace de noms dans l’URL :

Projet	URL
`explainer`	`/en/explainer/getting-started`
`my-api`	`/en/my-api/getting-started`
`cli-tool`	`/en/cli-tool/installation`

La page d’accueil (/) redirige vers la première page du premier projet.