v3.0.3 · Nuxt 文档主题

为 Nuxt 写文档.

一个可以直接 extends 的 Nuxt Layer:Markdown 写作、组件文档自动生成、AI 助手与 MCP Server 开箱即用,让文档站像一本认真排版的书。

pnpm add @movk/nuxt-docs @nuxt/content tailwindcss

01 — Docs

文档,自己写自己

组件的 Props、Slots、Emits 从源码提取,示例、提交历史与类型高亮都由内置组件完成,内容只需要 Markdown。

组件元数据自动提取

开启 componentDocs 后基于 nuxt-component-meta 读取 Vue 组件定义,无需手动维护 API 表格。

交互式示例

ComponentExample 自动加载示例并渲染预览与源码。

Git 提交历史

CommitChangelog 与 PageLastCommit 展示文件的变更记录与最后更新时间。

类型定义高亮

解析 TypeScript 类型并内联高亮,API 文档更易读。

文档专用组件

Callout、Steps、Tabs、Card 等由 Nuxt UI 提供,并统一为编辑式排版。

全文搜索与国际化

⌘K 搜索全部文档;opt-in 多语言按语言划分内容集合并输出 hreflang。

02 — AI

为人和 AI 同时排版

读者可以直接向文档提问;AI 编辑器通过 MCP Server、llms.txt 与 Agent Skills 读取同一份内容。

Movk Nuxt Docs 内置 AI 聊天助手
图 1内置 AI 助手在文档旁实时作答。

AI 聊天助手

基于 Vercel AI SDK,流式输出并实时高亮代码。

MCP Server

为 Cursor、VS Code 等编辑器提供结构化的文档访问,一键添加。

llms.txt

自动生成 llms.txt 与 llms-full.txt,为 AI 工具提供文档索引。

Agent Skills

将 skills/ 目录发布为 /.well-known/skills,让 AI 助手学会使用你的项目。

工具调用

助手可调用文档搜索、页面读取等工具,回答有据可查。

灵活的模型路由

AI Gateway、OpenAI 兼容端点或自注册厂商,一个配置切换。

从一个 Markdown 文件开始.

Copyright © 2024 - 2026