跳至主要内容

配置重定向

如果文章的标题、版本或位置发生更改,您可以创建指向当前内容的重定向。

关于重定向

如果对文章进行的更改影响了用户查找文章的能力,我们会从任何过时的版本创建到当前内容的重定向。如果文章标题已更改、添加了新版本或文件位置已更改,我们可能需要执行此操作。

重定向可以在本地或外部配置。

配置本地重定向

在 GitHub 文档中,您可以从一个文件重定向到另一个文件,或从一个版本重定向到另一个版本。

跨文件重定向

如果您更改了文章的名称,并希望其旧 URL 对所有版本重定向到其新 URL,请使用包含文章旧名称路径的 `redirect_from` 前置内容。如果您更改了文章的名称,并希望不同的版本重定向到不同的 URL,请按照“跨版本重定向”部分中的步骤操作。

在以下示例中,“关于提交的所有内容”文章已重命名为“创建您的第一个提交”。`redirect_from` 前置内容会将任何导航到旧文章 URL 的用户重定向到新文章 URL。

title: Creating your first commit
redirect_from:
  - /content/get-started/all-about-commits

有关详细信息,请参阅 GitHub 文档自述文件中的 `redirect_from`

对不包含版本的 URL 的自动重定向

如果输入页面的 URL 不包含版本(`https://docs.github.com/ARTICLE` 而不是 `https://docs.github.com/VERSION/ARTICLE`),则网站会将其自动重定向到页面的第一个可用版本。

优先级顺序在 `lib/all-versions.js` 中指定。当前优先级顺序为:

  1. GitHub 免费版、GitHub 专业版或 GitHub 团队版 ( `fpt` )
  2. GitHub Enterprise Cloud ( `ghec` )
  3. GitHub Enterprise Server ( `ghes` )

如果标题为 `ARTICLE` 的页面仅在 GitHub Enterprise Cloud 和 GitHub Enterprise Server 中可用,则链接 `https://docs.github.com/ARTICLE` 将自动重定向到 `https://docs.github.com/enterprise-cloud@latest/ARTICLE`,因为 GitHub Enterprise Cloud 的优先级高于 GitHub Enterprise Server。

如果 `ARTICLE` 在免费版、专业版或团队版中可用,则不会发生重定向,因为 `fpt` 页面没有版本段,因此 `fpt` 内容将在 `https://docs.github.com/ARTICLE` 处呈现。

跨版本重定向

如果您希望文章的一个版本的 URL 重定向到另一个版本的 URL 或完全不同的 URL,则必须更新 `src/redirects` 目录中的 redirect-exceptions.txt 文件。

例如,如果您删除文章的免费版、专业版或团队版 ( `fpt` ) 版本,则 URL 将自动重定向到页面的下一个可用版本。如果您希望它重定向到优先级较低的版本或完全不同的页面,则必须指定异常。

`redirect-exceptions` 文件中的每个条目都应以要重定向到的路径(包括版本)开头,后跟要重定向到的路径的无序列表。在以下示例中,无序列表中的路径将重定向到 GitHub Enterprise Cloud 版本的“导出组织的成员信息”。

/enterprise-cloud@latest/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
  - /[email protected]/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
  - /[email protected]/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
  - /[email protected]/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization

配置外部重定向

很少情况下,内容会移到 GitHub 文档网站之外。对于此类重定向,请更新 `src/redirects` 目录中的 `external-sites.json` 文件。

`external-sites.json` 文件中的每个条目都是一个键值对,其中键是内容所在路径,值是应重定向到的路径。

  "/github-status": "https://www.githubstatus.com/",
  "/articles/github-security": "https://github.com/security",