【问题标题】:Embedding html comments while using kramdown, jekyll and github-pages在使用 kramdown、jekyll 和 github-pages 时嵌入 html 注释
【发布时间】:2017-03-08 12:33:10
【问题描述】:

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

我需要嵌入在查看页面源代码时可见的 html cmets。这样做的原因是我希望能够直观地使用 cmets 来区分原始源 html 标记的不同部分。这可以通过使用常规 html 语法来实现:

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

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

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

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

这可行,但这样我在页面源代码中根本看不到它。我尝试过的另一个解决方案是this response 中描述的解决方法。它可以工作,但它会生成一个实际的 html 标记,因此注释和其他 html 标记之间的任何明确分隔都会丢失。

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

我在这里遗漏了什么,或者在与 github-pages 结合使用时不能保持 html cmets 完整吗?

编辑: 事实证明这毕竟不是标记或 Github 问题。我使用 CDN 服务,这缩小了 HTML 并剥离了 HTML cmets。

【问题讨论】:

  • 如果您只是在 .yml 文件中添加 &lt;!-- here's my comment --&gt;,它将在 html 页面的源代码中可用。
  • 在 GitHub 站点上呈现的 Markdown 文件将剥离原始 HTML 作为安全措施。您基本上需要请求 GitHub 禁用他们的安全性,这不会发生。
  • 你有仓库地址吗?
  • @Waylan 你碰巧有链接或类似的东西,所以我可以阅读并了解更多信息吗?目前我的搜索引擎技能似乎让我失望了。
  • @marcanuy 我不知道。有问题的文件不是 yaml 文件。它们是降价文件。

标签: comments markdown jekyll github-pages kramdown


【解决方案1】:

请检查 GitHub 上没有运行“HTML Minification”,这实际上可能会在提供服务以节省带宽时移除 cmets。

【讨论】:

  • 这实际上使我走上了正确的道路。事实证明,它毕竟 不是 标记或 Github 问题。我使用 CDN 服务,这实际上缩小了 HTML 并剥离了 HTML cmets。如果你没有回复,我可能不会想到它。
猜你喜欢
  • 2013-12-16
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2017-11-20
  • 1970-01-01
  • 2016-11-19
  • 1970-01-01
  • 2014-01-25
相关资源
最近更新 更多