Nextra — Next.jsベースのドキュメンテーションフレームワーク
概要
あなたはNextraの専門家です。Nextraは、Next.jsベースのドキュメンテーションフレームワークであり、MDXファイルをレンダリングし、全文検索、ダークモード、国際化(i18n)、シンタックスハイライトを内蔵しています。Markdown内でReactコンポーネントをサポートし、開発者がドキュメントサイト、ブログ、ナレッジベースを構築するのを支援します。
使用方法
セットアップ
npx create-next-app my-docs --example https://github.com/shuding/nextra-docs-template
cd my-docs && npm run dev
# または既存のNext.jsプロジェクトに追加
npm install nextra nextra-theme-docs
設定
// next.config.mjs
import nextra from "nextra";
const withNextra = nextra({
theme: "nextra-theme-docs",
themeConfig: "./theme.config.tsx",
defaultShowCopyCode: true,
search: { codeblocks: true }, // コードブロック内も検索対象にする
});
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ページ
---
title: はじめに
description: My SDKのクイックスタートガイド
---
import { Callout, Tabs, Tab, Steps, Cards, Card, FileTree } from 'nextra/components'
# はじめに
<Callout type="info">
このガイドは、Node.js 18以上がインストールされていることを前提としています。
</Callout>
## インストール
<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>
## クイックスタート
<Steps>
### SDKのインストール
```bash
npm install my-sdk
クライアントの初期化
import { SDK } from "my-sdk";
const client = new SDK({ apiKey: process.env.API_KEY });
最初のリクエストを実行
const users = await client.users.list();
console.log(users);
プロジェクト構造
関連リソース
自動ナビゲーション
## ファイルベースのルーティング
pages/
index.mdx → /
getting-started.mdx → /getting-started
guide/
_meta.json → サイドバーの順序とラベル
installation.mdx → /guide/installation
configuration.mdx → /guide/configuration
api/
_meta.json
reference.mdx → /api/reference
## _meta.json — サイドバーの順序を制御
{
"installation": "インストール",
"configuration": "設定",
"authentication": "認証",
"-- Separator": { "type": "separator", "title": "高度な設定" },
"plugins": "プラグイン",
"migration": "移行ガイド"
}
インストール
npm install nextra nextra-theme-docs
例
例1: ユーザーがNextraのセットアップを依頼
ユーザー: 「プロジェクトにNextraをセットアップして」
エージェントは以下を行うべき:
- システム要件と前提条件を確認する
- Nextraをインストールまたは設定する
- 初期プロジェクト構造を設定する
- セットアップが正しく動作することを確認する
例2: ユーザーがNextraで機能を構築するよう依頼
ユーザー: 「Nextraを使ってダッシュボードを作成して」
エージェントは以下を行うべき:
- コンポーネントまたは設定の雛形を作成する
- 適切なデータソースに接続する
- 要求された機能を実装する
- 出力をテストし、検証する
ガイドライン
- MDXによるインタラクティブ性 — ドキュメント内でReactコンポーネント(タブ、コールアウト、対話的な例)を使用する;MDXはこれをシームレスに実現する
- _meta.jsonによる整理 —
_meta.jsonを使用してサイドバーの順序とラベルを制御する;アルファベット順のファイル順序に依存しない - 組み込み検索 — NextraにはFlexSearchベースの全文検索が含まれている;小〜中規模サイトではAlgoliaのセットアップは不要
- Next.jsの機能 — SSR、ISR、APIルート、そしてNext.jsのエコシステム全体を活用できる;対話的なドキュメントに便利
- コードブロック機能 —
defaultShowCopyCode、ファイル名ラベル、コードブロック内の行ハイライトを有効化できる - ダークモード組み込み — Nextraのドキュメントテーマにはダークモードの切り替え機能が含まれている;すべてのコンポーネントが自動的に適応する
- i18n(国際化)対応 — 組み込みの国際化機能;同じ構造で言語フォルダ(en/, ja/, zh/など)を作成する
- Vercelへのデプロイ — ワンクリックデプロイ;ドキュメントの変更を含むすべてのプルリクエストに対して自動プレビューをデプロイする