简介

Movk Nuxt Docs 是一个可以直接 extends 的 Nuxt Layer,提供文档站所需的排版、导航、搜索、SEO 与 AI 能力。本页说明它适合什么项目、默认包含哪些功能、哪些功能按需开启。
查看源码

什么是 Movk Nuxt Docs

Movk Nuxt Docs 是发布为 npm 包 @movk/nuxt-docs 的 Nuxt Layer。在 nuxt.config.ts 中加一行 extends: ['@movk/nuxt-docs'],项目就拥有完整的文档站:页头、侧栏、目录、全文搜索、暗色模式、SEO 与 OG 图片。你只需要在 content/docs/ 中写 Markdown。

它基于 Nuxt 4、Nuxt UI 与 Nuxt Content 构建,正文支持 MDC 语法,可以在 Markdown 中直接使用 Vue 组件。

以下站点使用本主题构建:

mhaibaraai.cn

技术博客与知识库

@movk/core

Vue.js 实用工具与 Composables 库

@movk/nuxt

Nuxt 4 模块化工程套件,提供 Schema 驱动表单、UI 组件与工具函数

@movk/maplibre

声明式 MapLibre GL 封装库,无需 access token

@movk/sigma

基于 sigma v4 的知识图谱可视化 Nuxt 模块

默认包含

安装后无需额外配置即可使用:

  • 编辑式排版:衬线标题、编号栏目条、暖灰纸色背景与朱红主色,可在 主题与字体 中调整或换回无衬线
  • 导航:侧栏由 content/docs/ 目录结构生成,页头导航与侧栏分类在 app.config.ts 中声明,见 导航与分类
  • 搜索:⌘K 全文搜索,空搜索时展示当前语言的最近访问
  • SEO:站点地图、robots、Schema.org 结构化数据与构建期生成的 OG 图片
  • MCP Server:编辑器与 AI 助手可以通过 /mcp 结构化读取文档,见 MCP Server
  • 面向 AI 的内容:llms.txt、每页的 Markdown 表示(/raw/**.md)与 代理发现 端点
  • Git 集成:页面最后提交时间、编辑链接与 提交记录组件

按需开启

以下功能默认关闭,依赖以 optional peer 声明,启用时需自行安装。启用但缺少依赖时,构建会直接报错并给出安装命令。详见 功能开关。

功能开启方式用途
AI Chat设置 AI_API_KEY 环境变量,或 aiChat.enabled: true文档旁的 AI 助手,见 AI Chat
组件文档movkNuxtDocs.componentDocs: true从 Vue 源码生成 Props、Slots、Emits 表格与交互示例
MermaidmovkNuxtDocs.mermaid: true在代码块中绘制流程图、时序图等,见 Mermaid
国际化在 modules 中加入 @nuxtjs/i18n多语言内容与语言切换,见 国际化
无障碍检查movkNuxtDocs.a11y: true开发期通过 @nuxt/a11y 检查页面

下一步

安装

用模板创建新站点,或在现有 Nuxt 项目中接入 Layer。

从 v2 迁移

逐条对照 v3 的破坏性变更与新写法。
Copyright © 2024 - 2026