跳至主要内容

更改文章标题

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

更改文章标题

有时,需要更改帮助文章的标题。重新命名文章时,需要考虑几个因素。

更改文件名背景

文章标题直接对应于包含该文章的 Markdown 文件名,原因如下:

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

更改标题时应考虑更新的位置

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

前置内容和元数据部分

每篇文章都包含一个元数据部分或前置内容,位于文章的**顶部**,使用 YAML 语法格式化。此元数据部分生成文章标题,并包含其他重要数据,例如重定向,有时甚至包含链接到可复用介绍文本的简短描述 conrefs。

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

前置内容更新清单

  • 使用句子大小写更新标题
  • 更新重定向。几乎每次我们重新命名文章时,都应添加一个引用文章旧 URL 的重定向,并确保保留旧文章前置内容中的任何重定向。

文件名

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

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

父索引文件

确保更新其父index.md文件中的文件链接,该文件生成目录。

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

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