安装

View source
通过项目模板或 Layer 方式安装 Movk Nuxt Docs。

快速入门

选择合适的安装方式:

完整文档站点(推荐)

包含 ESLint、TypeScript 检查等开发工具的完整模板。

npx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs
cd my-docs
npm install
npm run dev

模块文档站点(精简)

精简模板,适合 npm 包文档,内置 Release 页面。

npx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/module my-module-docs
cd my-module-docs
npm install
npm run dev

启动后访问 http://localhost:3000

AI 助手 Skill

为你的 AI 助手(Cursor、Claude Code 等)添加 Movk Nuxt Docs 专业知识,加速文档编写:

npx skills add mhaibaraai/movk-nuxt-docs

此 Skill 为 AI 助手提供 Movk Nuxt Docs 专业知识,帮助你更高效地编写文档:

  • 📝 MDC 组件用法和现成模板
  • 🎨 中文文档写作规范和内容结构模式
  • 🔧 nuxt.config.ts 和 app.config.ts 配置参考
  • 📚 入门页、功能介绍页等常用页面模板

作为 Layer 使用

在现有 Nuxt 项目中集成:

npm install @movk/nuxt-docs better-sqlite3 tailwindcss

配置 Nuxt:

nuxt.config.ts
export default defineNuxtConfig({
+  extends: ['@movk/nuxt-docs']
})
Copyright © 2024 - 2026