开始写作
目录与文件命名
通过目录结构、数字前缀和 .navigation.yml 管理内容导航。
内容目录
项目使用两个内容根目录:
content/
├── docs/ # 文档集合,对应 /docs/**
└── blog/ # 博客集合,对应 /blog/**
建议使用数字前缀控制同级目录和文件的排序,例如:
content/docs/1.简单文档/
├── 1.index.md
├── 2.installation.md
├── 3.writing/
│ ├── 1.markdown.md
│ └── 2.pages.md
└── .navigation.yml
数字前缀主要用于排序,公开 URL 会由内容路径生成;重命名目录或文件可能改变 slug 和已有链接,发布前应检查站内链接、编辑链接和外部引用。
.navigation.yml
目录分组使用目录下的 .navigation.yml 配置。不要使用旧模板中的 _dir.yml,除非项目配置明确支持该文件。
title: 写作指南
description: Markdown、页面字段和目录组织方式。
icon: lucide:pen-line
可选字段以当前 Nuxt Content 导航能力和仓库已有示例为准。配置变更后应打开对应 /docs/** 页面检查侧边栏标题、描述和图标。
文档文件
---
title: 安装与开发
description: 本地安装、运行和检查方法。
navigation:
icon: lucide:play
---
正文内容。
文件名中的数字前缀可以帮助排序,但页面标题和导航显示应通过 frontmatter 的 title 控制。
博客文件
博客通常按分类目录组织:
content/blog/
├── 1.技术栈/
├── 2.AI/
└── 3.生活/
博客 frontmatter 必须包含 title、description、img 和 date。分类也可以通过 category 指定,标签通过 tags 指定。
发布前检查
- 确认文件位于正确的 collection 目录。
- 确认文件名和目录名不会意外改变 URL。
- 确认 frontmatter YAML 缩进和必填字段正确。
- 运行
pnpm content:check。 - 启动
pnpm dev,检查侧边栏、页面路径、目录和链接。