在站点内自定义链接地址

默认情况下，Fern 基于 docs.yml 文件中的导航结构生成页面的链接地址。

无选项卡示例

docs.yml

1 instances:
2   - url: plantstore.docs.buildwithfern.com
3   
4 navigation:
5   - section: Get Started
6     contents: 
7       - page: Welcome 
8         path: ./docs/pages/welcome.mdx

在上面的示例中，Welcome 页面将托管在 plantstore.docs.buildwithfern.com/get-started/welcome。

有选项卡示例

docs.yml

1 instances:
2   - url: plantstore.docs.buildwithfern.com
3   
4 tabs: 
5   docs:
6     display-name: Docs
7   reference: 
8     display-name: API Reference
9   
10 navigation:
11   - tab: docs
12     layout: 
13       - section: Get Started
14         contents: 
15           - page: Welcome 
16             path: ./docs/pages/welcome.mdx

在上面的示例中，Welcome 页面将托管在 plantstore.docs.buildwithfern.com/docs/get-started/welcome。

您可以通过重命名或完全跳过这些默认链接地址来自定义它们。

重命名链接地址

在 docs.yml 中或在页面的前置配置中设置 slug 属性来自定义 URL 路径。

修改页面或章节链接地址

要修改页面或章节使用的链接地址，您可以在 navigation 对象中设置 slug。

docs.yml

1 navigation:
2   - section: Get Started
3     slug: start
4     contents: 
5       - page: Welcome 
6         slug: intro
7         path: ./docs/pages/welcome.mdx

在上面的示例中，Welcome 页面将托管在 plantstore.docs.buildwithfern.com/start/intro。

修改选项卡链接地址

要修改选项卡使用的链接地址，您可以在 tabs 对象中设置 slug。

docs.yml

1 tabs: 
2   docs:
3     display-name: Docs
4     slug: guides
5   reference: 
6     display-name: API Reference
7   
8 navigation:
9   - tab: docs
10     layout: 
11       - section: Get Started
12         contents: 
13           - page: Welcome 
14             path: ./docs/pages/welcome.mdx

在上面的示例中，Welcome 页面将托管在 plantstore.docs.buildwithfern.com/guides/get-started/welcome。

修改落地页面的链接地址

要修改落地页面使用的链接地址，您可以在 landing-page 对象中设置 slug。

docs.yml

1 landing-page: 
2   page: Page Title
3   path: path/to/landing-page.mdx
4   slug: /welcome

使用前置配置覆盖页面的链接地址

前置配置中的链接地址优先于 docs.yml 中生成或设置的链接地址，让您完全控制页面的 URL。

docs.yml

1 navigation:
2   - section: Get Started
3     slug: start
4     contents:
5       - page: Quickstart
6         path: ./docs/pages/quickstart.mdx

使用这种配置，页面通常会在 plantstore.docs.buildwithfern.com/start/quickstart。要覆盖这个设置，请在页面的前置配置中设置 slug：

quickstart.mdx

1 ---
2 title: Quickstart
3 slug: start-up
4 ---

现在页面可在 plantstore.docs.buildwithfern.com/start/start-up 访问。查看前置配置获取更多详情。

为子标题重命名链接地址

默认情况下，子标题的深度链接通过在页面 URL 后面附加 # 和子标题的标题（转换为 kebab-casing-convention）来生成。

docs.yml

1 navigation:
2   - section: Get Started
3     contents: 
4       - page: Welcome 
5         path: ./docs/pages/welcome.mdx

welcome.mdx

1 ...
2 
3 ## Frequently Asked Questions 
4 ...

此章节的链接将在 plantstore.docs.buildwithfern.com/get-started/welcome#frequently-asked-questions 可用。

要重命名子标题的链接地址，添加所需的链接地址：

welcome.mdx

1 ## Frequently Asked Questions [#faqs]

此章节的链接现在将在 plantstore.docs.buildwithfern.com/get-started/welcome#faqs 可用。

跳过链接地址

要在生成链接地址时忽略选项卡或章节，只需指定 skip-slug: true。

无选项卡示例

docs.yml

1 instances:
2   - url: plantstore.docs.buildwithfern.com
3   
4 navigation:
5   - section: Get Started
6     skip-slug: true
7     contents: 
8       - page: Welcome 
9         path: ./docs/pages/welcome.mdx

在上面的示例中，Welcome 页面将托管在 plantstore.docs.buildwithfern.com/welcome。

有选项卡示例

docs.yml

1 instances:
2   - url: plantstore.docs.buildwithfern.com
3   
4 tabs: 
5   docs:
6     display-name: Docs
7     skip-slug: true
8   reference: 
9     display-name: API Reference
10   
11 navigation:
12   - tab: docs
13     layout: 
14       - section: Get Started
15         skip-slug: true
16         contents: 
17           - page: Welcome 
18             path: ./docs/pages/welcome.mdx

在上面的示例中，Welcome 页面将托管在 plantstore.docs.buildwithfern.com/welcome。