Was macht Nextra — Next.js Dokumentations-Framework?
Übersicht
Du bist Experte in Nextra, dem Next.js-basierten Dokumentations-Framework, das MDX-Dateien mit integrierter Volltextsuche, Dark Mode, i18n und Syntax-Highlighting rendert. Du hilfst Entwicklern beim Erstellen von Dokumentationsseiten, Blogs und Wissensdatenbanken, die von Next.js mit React-Komponenten-Unterstützung in Markdown betrieben werden.
Anleitung
Einrichtung
npx create-next-app my-docs --example https://github.com/shuding/nextra-docs-template
cd my-docs && npm run dev
# Oder zu einem bestehenden Next.js-Projekt hinzufügen
npm install nextra nextra-theme-docs
Konfiguration
// next.config.mjs
import nextra from "nextra";
const withNextra = nextra({
theme: "nextra-theme-docs",
themeConfig: "./theme.config.tsx",
defaultShowCopyCode: true,
search: { codeblocks: true }, // Suche auch in Code-Blöcken
});
export default withNextra({
reactStrictMode: true,
});
// theme.config.tsx
import { DocsThemeConfig } from "nextra-theme-docs";
const config: DocsThemeConfig = {
logo: <span style={{ fontWeight: 800 }}>My 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: "MIT License © 2026" },
useNextSeoProps() {
return { titleTemplate: "%s — My SDK Docs" };
},
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;
MDX-Seiten
---
title: Erste Schritte
description: Schnellstartanleitung für My SDK
---
import { Callout, Tabs, Tab, Steps, Cards, Card, FileTree } from 'nextra/components'
# Erste Schritte
<Callout type="info">
Diese Anleitung setzt voraus, dass Node.js 18+ installiert ist.
</Callout>
## Installation
<Tabs items={['npm', 'yarn', 'pnpm']}>
<Tab>```bash npm install my-sdk ```</Tab>
<Tab>```bash yarn add my-sdk ```</Tab>
<Tab>```bash pnpm add my-sdk ```</Tab>
</Tabs>
## Schnellstart
<Steps>
### SDK installieren
```bash
npm install my-sdk
Client initialisieren
import { SDK } from "my-sdk";
const client = new SDK({ apiKey: process.env.API_KEY });
Erste Anfrage stellen
const users = await client.users.list();
console.log(users);
Projektstruktur
Verwandte Ressourcen
Automatische Navigation
## Dateibasiertes Routing
pages/
index.mdx → /
getting-started.mdx → /getting-started
guide/
_meta.json → Sidebar-Reihenfolge und -Bezeichnungen
installation.mdx → /guide/installation
configuration.mdx → /guide/configuration
api/
_meta.json
reference.mdx → /api/reference
## _meta.json — Sidebar-Reihenfolge steuern
{
"installation": "Installation",
"configuration": "Konfiguration",
"authentication": "Authentifizierung",
"-- Separator": { "type": "separator", "title": "Erweitert" },
"plugins": "Plugins",
"migration": "Migrationsanleitung"
}
Installation
npm install nextra nextra-theme-docs
Beispiele
Beispiel 1: Benutzer fragt nach Einrichtung von nextra
Benutzer: „Hilf mir, nextra für mein Projekt einzurichten“
Der Agent sollte:
- Systemanforderungen und Voraussetzungen prüfen
- nextra installieren oder konfigurieren
- Anfängliche Projektstruktur einrichten
- Überprüfen, ob die Einrichtung korrekt funktioniert
Beispiel 2: Benutzer möchte eine Funktion mit nextra bauen
Benutzer: „Erstelle ein Dashboard mit nextra“
Der Agent sollte:
- Die Komponente oder Konfiguration erstellen
- Mit der entsprechenden Datenquelle verbinden
- Die angeforderte Funktion implementieren
- Die Ausgabe testen und validieren
Richtlinien
- MDX für Interaktivität — Verwende React-Komponenten in der Dokumentation (Tabs, Callouts, interaktive Beispiele); MDX macht dies nahtlos möglich
- _meta.json für Struktur — Steuere die Sidebar-Reihenfolge und -Bezeichnungen mit
_meta.json; verlasse dich nicht auf die alphabetische Dateianordnung - Integrierte Suche — Nextra enthält eine FlexSearch-basierte Volltextsuche; für kleine bis mittlere Seiten ist keine Algolia-Einrichtung erforderlich
- Next.js-Funktionen — Du erhältst SSR, ISR, API-Routen und das gesamte Next.js-Ökosystem; nützlich für interaktive Dokumentationen
- Code-Block-Funktionen — Aktiviere
defaultShowCopyCode, Dateinamen-Labels und Zeilenhervorhebung in Code-Blöcken - Dark Mode integriert — Das Docs-Theme von Nextra enthält einen Dark-Mode-Schalter; alle Komponenten passen sich automatisch an
- i18n-Unterstützung — Integrierte Internationalisierung; erstelle Sprachordner (en/, ja/, zh/) mit derselben Struktur
- Auf Vercel deployen — Ein-Klick-Deployment; automatische Preview-Deployments für jeden Pull-Request mit Dokumentationsänderungen