跳至主要内容

更改文章标题

当需要更改文章标题时,可能需要在多个地方更新该名称。

更改文章标题

有时,有必要更改帮助文章的标题。在重新命名文章时,需要注意若干事项。

更改文件名的背景

文章标题直接对应包含该文章的 Markdown 文件名,原因有以下几点

  • SEO: 当我们在 URL 中使用与文章内容相关的真实词语时,我们的文章在搜索引擎中的权重会更高。欲了解更多信息,请参阅 Google 搜索引擎优化入门指南 中的 “改进 URL 的结构”。

更改标题时应考虑更新的地点

更改文章标题时,可能需要更新多个位置。

Frontmatter 和元数据段

每篇文章在其 顶部 包含使用 YAML 语法格式化的元数据段或 frontmatter。该元数据段生成文章标题,并包含其他重要数据,例如重定向,有时甚至还有指向可重用导言文本的简短描述引用。

---
title: Your article name
intro:
redirect_from:
  - /articles/older-outdated-article-name/
---

Frontmatter 更新检查清单

  • 使用句首大小写更新标题
  • 更新重定向。几乎每次重新命名文章时,都应添加指向文章旧 URL 的重定向,并确保保留旧文章 frontmatter 中的任何重定向。

文件名

您可以在终端中使用 git mv 命令 来更改文件名。

$ git mv old-article-name.md new-article-name.md

父级索引文件

确保在父级的 index.md 文件中更新指向该文件的链接,该文件生成目录(TOC)。

我们在文档中通过链接在文章之间进行关联。建议搜索文件名和标题,以查找需要更新的链接。

在产品中搜索指向旧标题的链接。如果发现任何过时的链接,请联系相关团队或工程师,告知链接已更改并请他们更新。如果不确定该联系谁,可以向 GitHub 文档团队的成员询问。作为礼貌,您也可以创建一个包含已更新链接的 pull request,并请相关团队在新标题发布后合并。

© . This site is unofficial and not affiliated with GitHub, Inc.