Movk Nuxt Docs 是一个 Nuxt 层 (Layer)，它为您的标准 Nuxt 应用赋予了强大的文档功能，同时保留了 Nuxt 项目的完整灵活性。
当您使用 npx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs 创建一个新的 Movk Nuxt Docs 项目时，会生成以下结构：
my-docs/
├── app/
│ ├── assets/css/main.css # 全局样式
│ └── composables/ # 自定义 Composables
├── content/ # Markdown 内容
│ ├── index.md # 首页
│ └── docs/ # 文档页面
├── public/ # 静态资源
├── scripts/ # 脚本
├── nuxt.config.ts # Nuxt 配置
├── tsconfig.json # TypeScript 配置
├── package.json # 依赖与脚本
├── pnpm-workspace.yaml # pnpm 工作区配置
└── README.md # 项目说明
content/您可以在此目录中使用 Markdown 编写文档页面。Movk Nuxt Docs 会根据您的文件结构自动生成路由。
content/
├── index.md
└── docs/
├── 1.index.md
└── 2.installation.md
public/public/ 目录下的文件将直接在根路径提供服务，且不会被构建过程处理。您可以将图片、图标和其他静态资源存放在这里。
package.json此文件定义了项目的所有依赖项和脚本。一个典型的 Movk Nuxt Docs 项目的 package.json 文件非常精简：
{
"name": "movk-nuxt-docs-template",
"packageManager": "pnpm@10.18.3",
"scripts": {
"build": "nuxt build",
"dev": "nuxt dev"
},
"dependencies": {
"@movk/nuxt-docs": "latest",
"better-sqlite3": "^12.4.1",
"nuxt": "^4.1.3"
}
}
app/assets/css/main.css@import 'tailwindcss';
@import '@nuxt/ui';
@theme static {
--font-sans: 'Public Sans', sans-serif;
--container-8xl: 90rem;
}
:root {
--ui-container: var(--container-8xl);
}
nuxt.config.tsexport default defineNuxtConfig({
extends: ['@movk/nuxt-docs'],
css: ['~/assets/css/main.css'],
compatibilityDate: 'latest'
})
app.config.ts此文件对于启动 Movk Nuxt Docs 应用并非必需。
nuxt.config.ts 文件。您可以在此文件中配置 Movk Nuxt Docs，以匹配您的品牌、处理 SEO、以及自定义链接和社交媒体信息。