---
title: "项目结构"
description: "深入了解 Movk Nuxt Docs 项目的目录结构与各文件职责，包括 content/ 内容目录、public/ 静态资源、nuxt.config.ts 模块配置和 app.config.ts 运行时 UI 配置的详细说明及典型配置示例。"
seo_title: "Project Structure"
seo_description: "Understand the Movk Nuxt Docs project layout, including content files, public assets, Nuxt module configuration, and runtime app config."
canonical_url: "https://docs.mhaibaraai.cn/docs/getting-started/project-structure"
---
# 项目结构

> 深入了解 Movk Nuxt Docs 项目的目录结构与各文件职责，包括 content/ 内容目录、public/ 静态资源、nuxt.config.ts 模块配置和 app.config.ts 运行时 UI 配置的详细说明及典型配置示例。

## 整体结构

Movk Nuxt Docs 是一个 Nuxt Layer，扩展标准 Nuxt 应用为文档站点。

使用 `npx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs` 创建项目后的结构：

```bash
my-docs/
├── app/
│   └── composables/             # 自定义 Composables
├── content/                     # Markdown 内容
│   ├── index.md                 # 首页
│   └── docs/                    # 文档页面
├── public/                      # 静态资源
├── nuxt.config.ts               # Nuxt 配置
├── tsconfig.json                # TypeScript 配置
├── package.json                 # 依赖与脚本
├── .env.example                # 环境变量示例
└── pnpm-workspace.yaml          # pnpm 工作区配置
```

### 内容目录 `content/`

Markdown 文档存放位置，自动生成路由。

```bash
content/
├── index.md              # 首页内容
├── releases.yml          # 发布日志（可选，系统自动检测）
├── templates.yml         # 模板展示页（可选，系统自动检测）
└── docs/                 # 文档页面
    ├── 1.index.md
    └── 2.installation.md
```

> \[\!TIP\]
> See: /docs/getting-started/nuxt#自动路由
> 
> 系统会自动检测 
> 
> releases.yml
> 
>  / 
> 
> releases.md
> 
>  与 
> 
> templates.yml
> 
>  / 
> 
> templates.md
> 
>  文件，并分别创建 
> 
> /releases
> 
>  与 
> 
> /templates
> 
>  路由，无需手动配置。

### 公共资源目录 `public/`

静态资源目录，文件直接在根路径提供服务，不经过构建处理。存放图片、图标等资源。

### 依赖管理 `package.json`

定义项目依赖和脚本。典型的 `package.json` 非常精简：

```json [package.json]
{
  "name": "movk-nuxt-docs-template",
  "packageManager": "pnpm@10.33.0",
  "scripts": {
    "build": "nuxt build",
    "dev": "nuxt dev"
  },
  "dependencies": {
    "@movk/nuxt-docs": "latest",
    "better-sqlite3": "^12.6.0",
    "nuxt": "^4.3.0",
    "tailwindcss": "^4.1.18"
  }
}
```

### Nuxt 配置文件 `nuxt.config.ts`

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  extends: ['@movk/nuxt-docs'],
  css: ['~/assets/css/main.css'],
  aiChat: {
    model: 'zai/glm-4.7',
    models: [
      'zai/glm-4.7',
      'anthropic/claude-sonnet-4.6',
      'google/gemini-2.5-flash'
    ],
  },
  mcp: {
    name: 'My Docs'
  }
})
```

### 应用配置文件 `app/app.config.ts`

> \[\!NOTE\]
> 
> 此文件对于启动 Movk Nuxt Docs 应用并非必需。

您可以在此文件中配置 Movk Nuxt Docs，以匹配您的品牌、处理 SEO、以及自定义链接和社交媒体信息。


## Sitemap

See the full [sitemap](/sitemap.md) for all pages.