Skip to main content

Docs Introduction

原文 - Docs Introduction

文档(docs)特性让用户能够按照层级结构组织Markdown文档.

info

查看 Docs Plugin API Reference documentation 扩展文档功能

Document ID

每个文档都有一个唯一 id, 默认情况这个id是相对于文档根目录的相对路径名称(不包含扩展名).

比如 guide/hello.md 的 id 是 guide/hello.

website # Root directory of your site
└── docs
├── greeting.md
└── guide
└── hello.md

可以在md文档的配置中修改文档id的最后一部分, 比如下面文档的id就是 guide/part1:

guide/hello.md
---
id: part1
---

Lorem ipsum

Customizing doc URLs

默认情况下, 文档的URL地址是文档相对于docs目录的相对路径, 使用 slug 可以修改文档URL.

比如文档路径为 /docs/guide/hello.md, 默认URL为 /docs/guide/hello, 下面使用slug将该文档的URL改为了 /docs/bonjour:

/docs/guide/hello.md
---
slug: /bonjour
---

Lorem ipsum

slug 将会将路径追加到文档配置 routeBasePath 指定路径后面, 该配置默认为 /docs.