为什么标题会在 GitHub readme.md 降价页面中自动创建链接？

Question

您好：我已经为我的存储库和 GitHub 页面创建了 readme.md 文件。 但是当我创建格式为 h2/## 或 h3/### 等的标题时，会自动创建页内锚链接。 我尝试了不同的方法来格式化标题——例如##、、————但我得到了相同的结果。 它出现在每个标题中。 这发生在存储库中的 readme.md 文件和转换为 GitHub 页面的文件中。 我已经在 chrome 浏览器和 Edge 浏览器中测试过它，它的行为是相同的。

# sample将创建标题和不需要的页内链接

## sample将创建标题和不需要的页内链接

这是一个包含行为的页面： https : //burrittresearch.com/

我的目标是能够在不自动创建这些链接的情况下在 Markdown 中格式化标题。

谢谢！

Answer 1

这些是来自 GitHub 页面的anchorjs默认 CSS 规则的一部分

<h2 id="skills">Skills
  <a class="anchorjs-link" 
     href="#skills" 
     aria-label="Anchor" 
     data-anchorjs-icon="" 
     style="font: 1em / 1 anchorjs-icons; padding-left: 0.375em;">
  </a>
</h2>

如果你的静态页面（像这个）包含它自己的一组 CSS 文件/规则（像那些），你可以添加，以确保它们不可见：

.anchorjs-link {
  display: none !Important;
}

Answer 2

GitHub 在github/Markup 中记录了他们的标记处理。 请注意，Markdown 在第一步中转换为 HTML，它不会向标题添加任何锚点。 但是，在与 Markdown 解析分开的第 4 步中，文档中的所有标题都添加了锚点。 对所有内容都这样做，无论是否来自 Markdown、ReStructured Text、textile、asscidoc 等，并不特定于 Markdown。

请注意，以上仅适用于 github.com 上显示的用户提供的内容。 这是他们控制的网站，因此我们无法更改/覆盖该行为。

但是，GitHub 页面则不同。 默认情况下，GitHub Pages 使用 Jekyll 将 Markdown 文件转换为 HTML。 Jekyll 包含许多选项来控制 Markdown 的处理方式，包括auto_ids选项。 关闭该选项（将其设置为 false），Jekyll 将不再向每个标头添加 ID。 但是，这是一个 Kramdown 选项，但是，据我所知，GitHub Pages 是否使用Commonmark的 GitHub Flavored Markdown 变体，它没有任何此类选项。 就此而言，GFM 规范也没有表明标头会被分配 ID（所以我不确定这些 ID 来自哪里）。 您可以尝试将 Jekyll 配置为在关闭auto_ids选项的情况下使用 Kramdown。 配置选项“可以在放置在站点根目录中的_config.yml或_config.toml文件中指定。”

作为替代方案，您可以在本地安装 Jekyll（或任何其他静态站点生成器）并在上传到 GitHub 页面之前构建站点。 只需在站点根目录中包含一个名为.nojekyll的空文件，GitHub 将不会通过 Jekyll 运行您的文件。 通过这种方式，您可以完全控制页面的内容和格式。