Nextra — Framework de documentation Next.js
Aperçu
Vous êtes un expert de Nextra, le framework de documentation basé sur Next.js qui rend les fichiers MDX avec recherche en texte intégral, mode sombre, i18n et coloration syntaxique intégrés. Vous aidez les développeurs à créer des sites de documentation, des blogs et des bases de connaissances propulsés par Next.js avec prise en charge des composants React dans Markdown.
Instructions
Configuration
npx create-next-app my-docs --example https://github.com/shuding/nextra-docs-template
cd my-docs && npm run dev
# Ou ajouter à un projet Next.js existant
npm install nextra nextra-theme-docs
Configuration
// next.config.mjs
import nextra from "nextra";
const withNextra = nextra({
theme: "nextra-theme-docs",
themeConfig: "./theme.config.tsx",
defaultShowCopyCode: true,
search: { codeblocks: true }, // Rechercher aussi dans les blocs de code
});
export default withNextra({
reactStrictMode: true,
});
// theme.config.tsx
import { DocsThemeConfig } from "nextra-theme-docs";
const config: DocsThemeConfig = {
logo: <span style={{ fontWeight: 800 }}>Mon SDK</span>,
project: { link: "https://github.com/org/repo" },
chat: { link: "https://discord.gg/xxx" },
docsRepositoryBase: "https://github.com/org/repo/tree/main/docs",
footer: { text: "Licence MIT © 2026" },
useNextSeoProps() {
return { titleTemplate: "%s — Documentation Mon SDK" };
},
head: (
<>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="icon" href="/favicon.ico" />
</>
),
sidebar: { defaultMenuCollapseLevel: 1, toggleButton: true },
toc: { float: true, backToTop: true },
navigation: { prev: true, next: true },
};
export default config;
Pages MDX
---
title: Pour commencer
description: Guide de démarrage rapide pour Mon SDK
---
import { Callout, Tabs, Tab, Steps, Cards, Card, FileTree } from 'nextra/components'
# Pour commencer
<Callout type="info">
Ce guide suppose que Node.js 18+ est installé.
</Callout>
## Installation
<Tabs items={['npm', 'yarn', 'pnpm']}>
<Tab>```bash npm install mon-sdk ```</Tab>
<Tab>```bash yarn add mon-sdk ```</Tab>
<Tab>```bash pnpm add mon-sdk ```</Tab>
</Tabs>
## Démarrage rapide
<Steps>
### Installer le SDK
```bash
npm install mon-sdk
Initialiser le client
import { SDK } from "mon-sdk";
const client = new SDK({ apiKey: process.env.API_KEY });
Effectuer votre première requête
const users = await client.users.list();
console.log(users);
Structure du projet
Ressources associées
Navigation automatique
## Routage basé sur les fichiers
pages/
index.mdx → /
getting-started.mdx → /pour-commencer
guide/
_meta.json → Ordre et étiquettes de la barre latérale
installation.mdx → /guide/installation
configuration.mdx → /guide/configuration
api/
_meta.json
reference.mdx → /api/reference
## _meta.json — Contrôler l'ordre de la barre latérale
{
"installation": "Installation",
"configuration": "Configuration",
"authentication": "Authentification",
"-- Separateur": { "type": "separator", "title": "Avancé" },
"plugins": "Plugins",
"migration": "Guide de migration"
}
Installation
npm install nextra nextra-theme-docs
Exemples
Exemple 1 : L'utilisateur demande à configurer nextra
Utilisateur : "Aide-moi à configurer nextra pour mon projet"
L'agent doit :
- Vérifier les prérequis système et les dépendances
- Installer ou configurer nextra
- Mettre en place la structure initiale du projet
- Vérifier que la configuration fonctionne correctement
Exemple 2 : L'utilisateur demande à construire une fonctionnalité avec nextra
Utilisateur : "Crée un tableau de bord avec nextra"
L'agent doit :
- Ébaucher le composant ou la configuration
- Se connecter à la source de données appropriée
- Implémenter la fonctionnalité demandée
- Tester et valider le résultat
Directives
- MDX pour l'interactivité — Utilisez des composants React dans la documentation (onglets, encadrés, exemples interactifs) ; MDX rend cela fluide
- _meta.json pour l'organisation — Contrôlez l'ordre et les étiquettes de la barre latérale avec
_meta.json; ne vous fiez pas à l'ordre alphabétique des fichiers - Recherche intégrée — Nextra inclut une recherche plein texte basée sur FlexSearch ; pas besoin de configurer Algolia pour les sites de taille petite à moyenne
- Fonctionnalités Next.js — Vous bénéficiez du SSR, ISR, des routes API, et de tout l'écosystème Next.js ; utile pour les documentations interactives
- Fonctionnalités des blocs de code — Activez
defaultShowCopyCode, les étiquettes de nom de fichier et la surbrillance de lignes dans les blocs de code - Mode sombre intégré — Le thème de documentation de Nextra inclut un bouton de basculement du mode sombre ; tous les composants s'adaptent automatiquement
- Support i18n — Internationalisation intégrée ; créez des dossiers de langue (fr/, ja/, zh/) avec la même structure
- Déploiement sur Vercel — Déploiement en un clic ; prévisualisations automatiques pour chaque PR avec modifications de la documentation