菜单
开源 RSS
最后审阅日期:2024 年 6 月 24 日

链接

根据您的目标选择链接类型

虽然这些其他类型的链接仍然有效,但请将其替换为前面任一选项

使用 URL,包括版本替换语法(如果需要)。例如

/docs/grafana/<GRAFANA_VERSION>/alerting/fundamentals/alert-rules/

在链接渲染过程中,Hugo 会检查链接目标是否为挂载源。如果是挂载的,则 Hugo 会检查当前页面是否与挂载目标属于同一项目。如果属于同一项目,则 Hugo 会将链接目标替换为挂载目标。如果未挂载,或者挂载目标不属于同一项目,则 Hugo 会按正常方式使用链接。

注意

自动挂载链接要求文档平台团队在挂载目标的前置信息中设置 mount_links: true

具有自动挂载链接的项目包括

如果您希望其他项目使用此行为,请在 #docs-platform Slack 频道联系文档平台团队。

Grafana Labs 网站配置将开源 Grafana Alerting 文档挂载到 Grafana Cloud 文档中。

在 Grafana Alerting 介绍页面中,链接 [alert rule](/docs/grafana/<GRAFANA_VERSION>/alerting/fundamentals/alert-rules/) 在页面的开源版本和云版本中具有不同的目标。

ref URI

对于大多数链接,自动挂载链接的行为是正确的,但有时您可能希望显式控制链接的多个目标。为此,请使用 ref URI。

ref URI 有两个组成部分

ref URI 根据页面的 URL 路径和页面前置信息中的定义查找目标。

包含 ref URI 的链接如下所示

markdown
[LINK TEXT](ref:<KEY>)

对于 <KEY>,输入字母术语。它可以包含连字符 (-)。

Hugo 会在页面前置信息中的 refs 字段值中查找 <KEY>。如果 refs 字段中没有 <KEY>,或者前置信息中没有 refs 字段,Hugo 会记录构建错误。

Front Matter

包含 refs 字段的部分前置信息如下所示

yaml
refs:
  <KEY>:
    - pattern: <URL PATH PREFIX>
      destination: <FULL URL>
    - pattern: <URL PATH PREFIX>
      destination: <FULL URL>
  • <URL PATH PREFIX> - 输入表示文档发布所在项目的页面 URL 部分。
  • destination - 输入该项目目标页面的完整 URL,包括末尾斜杠。

如果页面的 URL 匹配 <URL PATH PREFIX> 模式,则 Hugo 使用 destination 作为链接目标。如果没有模式匹配当前页面,Hugo 会记录构建错误。

<FULL URL> 目标具有与 链接到 grafana.com 页面 中描述的相同行为

示例

以下 Markdown 代码片段演示了使用 ref URI 的 refs 前置信息和链接。

markdown
---
refs:
  find-plugins:
    - pattern: /docs/grafana/
      destination: /docs/grafana/<GRAFANA_VERSION>/administration/plugin-management/#browse-plugins
    - pattern: /docs/grafana-cloud/
      destination: /docs/grafana-cloud/introduction/find-and-use-plugins/
---

# Manage plugins

## Before you begin

- Find the plugin you want to install. To find a plugin, refer to [Find and use plugins](ref:find-plugins).

在 Grafana 文档页面的最新版本中,链接目标是 https://grafana.org.cn/docs/grafana/latest/administration/plugin-management/#browse-plugins。Hugo 将版本替换语法 <GRAFANA_VERSION> 替换为从当前页面推断的版本。

在 Grafana Cloud 页面中,链接目标是 https://grafana.org.cn/docs/grafana-cloud/introduction/find-and-use-plugins/

使用 URL。

如果您链接到版本化文档,请使用带有版本替换语法的 URL,而不是版本路径元素。例如,在 Grafana 中,在 URL https://grafana.org.cn/docs/grafana/latest/ 中使用 <GRAFANA_VERSION> 而不是 latest

当 Hugo 渲染带有版本替换的链接时,它会将 <SOMETHING_VERSION> 语法替换为从当前页面推断的版本。

要更详细地了解此行为,请参阅 关于版本替换 您可以使用带有替换变量的完整 URL,以便链接解析到正确版本的文档,而无需作者在每次发布时更新版本。有关行为示例,请参阅 示例

要覆盖通过版本替换推断的版本,请在文档的根 _index.md 文件中设置首选版本。以下 YAML 代码片段将该页面及其所有子页面的 GRAFANA_VERSION 设置为 latest。您必须将以下 YAML 示例与根 _index.md 文件中的前置信息合并。

yaml
cascade:
  GRAFANA_VERSION: latest

示例

链接到 Grafana 文档:

https://grafana.org.cn/docs/grafana/<GRAFANA_VERSION>/ 开头,并添加 URL 的其余部分。包括末尾斜杠。

例如,要链接到开发人员页面并进行版本替换,请使用

markdown
https://grafana.org.cn/docs/grafana/<GRAFANA_VERSION>/developers/
  • 如果您从 Grafana 文档中链接,Hugo 会将 <GRAFANA_VERSION> 替换为从页面 URL 推断的版本。
  • 如果您从其他文档中链接,Hugo 会将 <GRAFANA_VERSION> 替换为源页面前置信息中 GRAFANA_VERSION 的值。

链接到 Grafana Cloud 文档:

Grafana Cloud 文档没有版本控制,不需要版本替换语法。使用完整 URL。

例如,要链接到创作并运行测试页面,请使用

markdown
https://grafana.org.cn/docs/grafana-cloud/k6/author-run/

链接到 Mimir 文档:

https://grafana.org.cn/docs/grafana/<MIMIR_VERSION>/ 开头,并添加 URL 路径的其余部分。

例如,要链接到发布说明页面并进行版本替换,请使用

markdown
https://grafana.org.cn/docs/mimir/<MIMIR_VERSION>/release-notes/
  • 如果您从 Mimir 文档中链接,Hugo 会将 <MIMIR_VERSION> 替换为从页面 URL 推断的版本。
  • 如果您从其他文档中链接,Hugo 会将 <MIMIR_VERSION> 替换为源页面前置信息中 MIMIR_VERSION 的值。

使用完整 URL。精确复制地址栏中的 URL。如果包含末尾斜杠,请包含它。如果不包含末尾斜杠,请不要添加。

例如

markdown
https://github.com

通过以下两种方式之一链接到页面上的标题。

从同一页面内链接

markdown
Read more in the [Configuration section](#configuration) of this page.

从不同页面链接

markdown
Read more in the [Grafana Open Source section of the Introduction page](https://grafana.org.cn/docs/grafana/<GRAFANA_VERSION>/fundamentals/#grafana-open-source).

在页面标题前的井号 (#) 之前包含末尾斜杠。

要将标题转换为锚点,请进行以下更改

  1. 转换为小写。
  2. 删除任何句号字符 (.)。
  3. 将任何非小写字母、数字或下划线 (_) 的字符替换为连字符 (-)。
  4. 修剪任何前面或后面的连字符 (-)。
  5. 前面加上 #

标题 *链接到页面标题* 变为锚点 #link-to-page-headings