文档版本管理

为多个文档版本自定义导航与提示横幅。

根据项目的发布和版本管理方式，你可能需要让用户访问旧版文档。旧版本的具体部署方式由你决定。本页介绍 OINK 提供的功能：在各个文档版本之间导航，并在归档站点上显示信息横幅。

如果在 hugo.toml、hugo.yaml 或 hugo.json 中添加 [params.versions]，OINK 会在顶部导航栏加入版本下拉选择器。请为每个需要加入菜单的版本指定 URL 和名称，例如：

# Add your release versions here
[[params.versions]]
  version = "master"
  url = "https://master.kubeflow.org"

[[params.versions]]
  version = "v0.2"
  url = "https://v0-2.kubeflow.org"

[[params.versions]]
  version = "v0.3"
  url = "https://v0-3.kubeflow.org"

params:
  versions:
    - version: master
      url: 'https://master.kubeflow.org'
    - version: v0.2
      url: 'https://v0-2.kubeflow.org'
    - version: v0.3
      url: 'https://v0-3.kubeflow.org'

{
  "params": {
    "versions": [
      {
        "version": "master",
        "url": "https://master.kubeflow.org"
      },
      {
        "version": "v0.2",
        "url": "https://v0-2.kubeflow.org"
      },
      {
        "version": "v0.3",
        "url": "https://v0-3.kubeflow.org"
      }
    ]
  }
}

别忘了加入当前版本，这样用户才能返回！

版本下拉菜单的默认标题是 Releases。要修改标题，请在 hugo.toml、hugo.yaml 或 hugo.json 中调整站点参数 version_menu：

[params]
version_menu = "Releases"

params:
  version_menu: Releases

{
  "params": {
    "version_menu": "Releases"
  }
}

如果把 version_menu_pagelinks 参数设为 true，版本下拉菜单会链接到其他版本中的当前页面，而不是它们的首页。如果文档在不同版本之间变化不大，这项功能会很有用。请注意：如果当前页面在另一版本中不存在，链接就会失效。

还可以分别配置每个菜单项：

如果菜单标签不是版本号，使用 name 代替 version。
将 name 设为 --- 可添加菜单分隔线。
省略 url 可渲染禁用的文本项，例如分组标题。
设置 kind 可添加与类型对应的 CSS 类。详情请参阅导航与菜单。
即使全局 version_menu_pagelinks 参数为 true，仍可在某个菜单项上设置 pagelinks: false，让它始终链接到该版本首页。

例如：

params:
  version_menu: v1.2
  version_menu_pagelinks: true
  versions:
    - name: '**Versions**'
    - version: v1.3-dev
      kind: next
      url: https://next.example.com
    - version: v1.2
      kind: latest
      url: https://docs.example.com
    - name: ---
    - name: Preview variant
      kind: home
      pagelinks: false
      url: https://preview.example.com

要进一步了解 OINK 菜单，请参阅导航与菜单。

如果为旧版文档创建归档快照，可以在归档文档的每个页面顶部添加提示，告诉读者他们正在查看不再维护的快照，并提供指向最新版本的链接。

例如，可以查看 Kubeflow v0.6 归档文档：

一个文本框，说明当前页面是不再维护的文档快照。 — 图 1：Kubeflow v0.6 归档文档中的横幅

要在文档站点加入横幅，请在 hugo.toml、hugo.yaml 或 hugo.json 中完成以下修改：

将站点参数 archived_version 设为 true：

[params]
archived_version = true

params:
  archived_version: true

{
  "params": {
    "archived_version": true
  }
}

将站点参数 version 设为归档文档集的版本。例如，如果归档文档对应 0.1 版：
```
[params]
version = "0.1"
```
```
params:
  version: 0.1
```
```
{
  "params": {
    "version": "0.1"
  }
}
```

确认站点参数 url_latest_version 包含希望读者前往的网站 URL。大多数情况下，它应该是最新版文档的 URL：

[params]
url_latest_version = "https://your-latest-doc-site.com"

params:
  url_latest_version: https://your-latest-doc-site.com

{
  "params": {
    "url_latest_version": "https://your-latest-doc-site.com"
  }
}

文档版本管理

添加版本下拉菜单

在归档文档站点显示横幅