mcpField
N
nextra-writer

nextra-writer

github.com/shipshitdev开发38194 次安装2 天前更新
代码仓库

关于 nextra-writer

面向使用 Nextra 的技术文档作者，帮助配置和维护文档项目，涵盖 MDX 内容、导航结构及常见文档组件。

主要功能

  1. 01Nextra 文档编写
  2. 02配置指南
  3. 03使用 _meta.json 设置导航
  4. 04MDX 组件模式
  5. 05规划文档层级

适用场景

  1. 01创建或更新 Nextra 文档
  2. 02配置文档导航
  3. 03编写 API 文档
  4. 04组织指南与参考页面

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/shipshitdev/skills --skill nextra-writer

安装后在 Claude Code 中输入/nextra-writer确认已加载。

附带文件plugin.jsonreferences/full-guide.md

详细介绍

Nextra 技术文档编写者

何时启用

  • 创建或更新 Nextra 文档（.md、.mdx）
  • 配置 Nextra 设置（next.config.mjs、theme.config.tsx）
  • 编写 API 文档
  • 组织文档结构和导航
  • 设置文档搜索和导航

技术栈

技术版本
Nextra3.x
Next.js14.x / 15.x
React18.x / 19.x
TypeScript5.x
MDX3.x

快速开始

# Create new Nextra docs
bun create next-app docs --example nextra-docs-template

# Or add to existing Next.js project
bun add nextra nextra-theme-docs

项目结构

docs/
├── pages/
│   ├── _meta.json          # Navigation config
│   ├── index.mdx           # Home page
│   ├── getting-started.mdx
│   └── api/
│       ├── _meta.json
│       └── endpoints.mdx
├── theme.config.tsx        # Theme configuration
├── next.config.mjs         # Next.js + Nextra config
└── package.json

导航

通过 _meta.json 配置：

{
  "index": "Introduction",
  "getting-started": "Getting Started",
  "---": {
    "type": "separator"
  },
  "api": "API Reference"
}

主要功能

功能模式
提示框<Callout type="info">
选项卡<Tabs items={['npm', 'yarn']}>
卡片<Cards> 组件
步骤<Steps> 组件
文件树<FileTree> 组件

文档层级

  1. 快速开始（5-10 分钟）
  2. 核心概念
  3. 功能文档
  4. 指南与教程
  5. API 参考
  6. 高级主题

集成

技能使用时机
docs通用技术写作
api-design-expertAPI 文档结构
frontend-design自定义文档 UI

详细配置、MDX 模式和组件示例： references/full-guide.md

评论

支持 Markdown