更改文章的标题
有时,必须更改帮助文章的标题。 给文章重加标题时,需要记住几个注意事项。
更改文件名的背景
由于以下原因,文章的标题直接对应于包含该文章的 Markdown 文件的名称:
- SEO:当我们在 URL 中使用与文章内容相关的真实字词时,我们的文章对搜索引擎的权重更大。 有关详细信息,请参阅 Google 搜索引擎优化入门指南中的“改进 URL 的结构”。
更改标题时应考虑更新的位置
为文章提供新标题时,可能需要更新多个位置。
前辅文和元数据部分
每篇文章都包含一个元数据部分或位于文章顶部的前辅文,使用 YAML 语法进行格式化。 此元数据部分生成文章的标题,并包含其他重要数据,例如重定向,有时甚至包含链接到可重用简介文本的简短说明内容引用。
---
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
文件中的文件的链接,这将生成 TOC。
其他文章中的内联链接
我们在文档中的文章之间进行链接。 建议同时搜索文件名和标题,以查找要更新的链接。
GitHub
上的链接
在产品中搜索指向旧标题的链接。 如果发现任何过时的链接,请联系相关团队或工程师,让他们知道链接已更改,要求他们进行更新。 如果你不确定要联系谁,可以询问 GitHub Docs 团队的成员。 出于一种形式,你也可以创建一个带有更新链接的拉取请求,要求相关团队在更新的文章标题发布后合并它。