构建现代智能的文档

基于 Nuxt 4 的现代文档主题,集成组件自动化文档、AI 聊天助手、MCP Server 和完整的开发者体验优化,助您轻松构建美观、专业、智能的文档网站。
nuxt.config.ts
export default defineNuxtConfig({
  extends: ['@movk/nuxt-docs'],
  aiChat: {
    model: 'mistral/devstral-2',
    models: ['mistral/devstral-2', 'openrouter/qwen/qwen3-4b:free']
  },
  mcp: {
    name: 'My Docs'
  }
})

自动化文档生成

    组件元数据自动提取
    基于 nuxt-component-meta 自动提取 Vue 组件的 Props、Slots、Emits 定义,无需手动维护文档。
    交互式示例展示
    通过 ComponentExample 组件自动加载和渲染组件示例,支持代码高亮和实时预览。
    Git 提交历史集成
    使用 CommitChangelogPageLastCommit 组件自动展示文件的提交历史记录和最后更新时间。
    类型定义高亮
    智能解析 TypeScript 类型定义,支持内联类型高亮和类型导航,提升 API 文档可读性。
    丰富的文档组件
    内置 Accordion、Callout、Card、Steps、Tabs 等多种文档专用组件,由 Nuxt UI 提供支持。
    全文搜索
    基于 Nuxt Content 的 ContentSearch 组件,支持键盘快捷键(⌘K)快速搜索文档内容。

AI 增强体验

    AI 聊天助手
    内置智能文档助手,基于 Vercel AI SDK 支持多种 LLM 模型(Mistral、Qwen、OpenRouter),实时解答文档相关问题。
    MCP Server 支持
    集成 Model Context Protocol 服务器,为 AI 助手提供结构化的文档访问能力,提升对话准确性。
    LLM 优化
    通过 nuxt-llms 模块自动生成 llms.txtllms-full.txt,为 AI 工具提供优化的文档索引。
    流式响应
    支持 AI 响应流式输出和代码高亮,配合 shiki-stream 实现实时语法高亮渲染。
    工具调用支持
    AI 助手可调用内置工具函数进行文档搜索、组件查询等操作,提供更精准的答案。
    灵活的模型配置
    支持自定义 AI 模型列表、API 端点和参数,轻松切换不同的 LLM 服务提供商。
Copyright © 2024 - 2026