更改文章的标题
有时,需要更改帮助文章的标题。重新命名文章时,需要考虑几个因素。
更改文件名背景
文章的标题直接对应于包含该文章的 Markdown 文件的名称,原因有以下几个
- SEO:当我们在 URL 中使用与文章内容相关的真实单词时,我们的文章在搜索引擎中的权重会更高。有关更多信息,请参阅 Google 搜索引擎优化入门指南 中的“改善 URL 结构”。
更改标题时应考虑更新的位置
为文章指定新标题时,可能需要更新多个位置。
页眉和元数据部分
每篇文章都包含一个元数据部分或页眉,位于文章顶部,使用 YAML 语法进行格式化。此元数据部分会生成文章标题,并包含其他重要数据,例如重定向,有时甚至包含链接到可重复使用简介文本的简短描述 conref。
---
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 中的链接
在产品中搜索指向旧标题的链接。如果你发现任何过时的链接,请联系相关团队或工程师,告知他们链接已更改,并要求他们进行更新。如果你不确定要联系谁,可以询问 GitHub Docs 团队的成员。作为一种礼貌,你还可以创建一个包含更新链接的拉取请求,并在更新的文章标题发布后要求相关团队将其合并。