文件属性

2025年7月16日

阅读需 3 分钟

Markdown 文件的属性支持主要通过 MDX（Markdown + JSX）和 Front Matter 实现

属性名	描述	示例值	用途
`id`	文档唯一标识符	`my-document`	用于路由和内部链接（如 `[链接](/docs/my-document)`）
`title`	页面标题	`快速入门指南`	显示在页面顶部和浏览器标签，默认使用一级标题（`# 标题`）
`description`	页面描述	`本文介绍如何快速上手...`	用于搜索引擎优化（SEO）和元标签
`slug`	自定义 URL 路径	`custom-path`	覆盖默认路由（如 `/docs/custom-path` 而非 `/docs/my-document`）
`sidebar_label`	侧边栏显示文本	`入门指南`	替代文件名显示在侧边栏
`sidebar_position`	侧边栏排序位置	`10`	数值越小越靠前（支持整数或浮点数）
`hide_table_of_contents`	是否隐藏目录	`true`	禁用自动生成的页面目录

有用的文件属性：

slug : 自定义 URL 路径，主要是展示在浏览器地址栏 sidebar_label: 侧边栏显示文本

在 Docusaurus 中，id 是 Markdown 文件的核心属性之一，用于唯一标识文档并确定其路由路径。以下是关于 id 属性的详细解析：

唯一标识符
- 每个文档必须有唯一的 id，用于内部引用和管理。
- 冲突的 id 会导致构建错误（如 Duplicate doc id）。
路由生成
- 默认情况下，Docusaurus 使用 id 作为文档的路由路径。
- 例如：id: getting-started → 访问路径为 /docs/getting-started。

在 Front Matter 中直接定义：

---
id: custom-id
title: 自定义 ID 示例
---

访问路径：/docs/custom-id

若未指定 id，Docusaurus 会根据文件路径自动生成：

文档文件（位于 docs/ 目录）：
- 文件路径：docs/guide/installation.md → id: guide/installation
- 访问路径：/docs/guide/installation
博客文章（位于 blog/ 目录）：
- 文件路径：blog/2023/10/05/hello-world.md → id: 2023/10/05/hello-world
- 访问路径：/blog/2023/10/05/hello-world

id 直接映射到 URL 路径：

---
id: advanced/configuration
---

访问路径：/docs/advanced/configuration

slug 可覆盖 id 生成的默认路径：

---
id: advanced/configuration
slug: /custom/path
---

访问路径：/docs/custom/path（而非 /docs/advanced/configuration）

详情见：