使用 kramdown、jekyll 和 github-pages 时嵌入 html 评论

Question

我使用 github、github-pages、kramdown 和 jekyll 来发布我的静态网站。

我需要嵌入 html 查看页面源代码时可见的评论。这样做的原因是我希望能够 在视觉上使用注释来区分 原始源 html 标记的不同部分。这可以通过使用常规 html 语法来实现：

<!-- here's my comment -->

我遇到的问题是，当我在本地提供我的 jekyll 站点时，我确实在页面源代码中看到了评论，但是一旦推送到我的 github 存储库，评论 就没有了 可见了。但是，当查看原始 markdown 源文件时，它在我的 repo 中仍然可见。

我期望的行为是在页面源代码中看到我的评论，就像我在本地所做的那样。我试过了 kramdown comment syntax:

{::comment}
 here's my comment
{:/comment}

这行得通，但这样一来我在页面源代码中根本看不到它。我尝试过的另一个解决方案是 this response 中描述的解决方法。它有效，但它会产生一个实际的 html 标签，因此评论和其他 html 标签之间的任何 清晰分隔 都将丢失。

底线是 我想在查看我的页面源代码时看到评论 即使 在将我的文件推送 到我的存储库之后.

这里有什么我遗漏的吗？或者在与 github-pages 结合使用时是否可以保持 html 评论完整无缺？

编辑： 结果证明这毕竟不是标记或 Github 问题。我使用 CDN 服务，这缩小了 HTML 并删除了 HTML 评论。

Answer 1

请检查 GitHub 上没有 "HTML Minification" 运行 这可能会在服务时删除评论以节省带宽。