markdown - RemarkJS 中的注释

Question

是否可以在 RemarkJS 演示文稿的 Markdown 内容中添加内联注释？

在其他 Markdown 格式中，我使用[//]:(SOME_COMMENT)了一种隐藏评论/标签的方式。备注是按字面意思显示这些。

我意识到我可以使用演讲者笔记，但对于我的用例，我希望能够使用标识符来注释 Markdown 的特定位。

Answer 1

使用原始 HTML 注释。

标准 Markdown没有特定于注释的语法。该[//]:(SOME_COMMENT)语法是非标准的，大多数实现都不支持（我从来不知道使用它的实现不会大量修改标准语法）。

如规则所述：

Markdown 不是 HTML 的替代品，甚至不能接近它。它的语法非常小，只对应非常小的 HTML 标记子集。我们的想法不是创建一种更容易插入 HTML 标记的语法。在我看来，HTML 标签已经很容易插入了。Markdown 的想法是让阅读、编写和编辑散文变得容易。HTML 是一种发布格式；Markdown 是一种写作格式。因此，Markdown 的格式化语法只解决了可以用纯文本表达的问题。

对于 Markdown 语法未涵盖的任何标记，您只需使用 HTML 本身。无需为它加上前缀或定界以表明您正在从 Markdown 切换到 HTML；您只需使用标签。

因此，一个简单的原始 HTM 注释就可以解决问题：

<!-- SOME_COMMENT -->

<!--

    A multiline comment.

-->

请注意上述规则中引用的设计背后的理念：“HTML 是一种发布格式；Markdown 是一种写作格式。” 当您理解这一点时，那些经过大量修改的实现看起来就像 Markdown 之外的东西，并且您对 Markdown 是什么以及它可以做什么产生了不同的期望。它的设计很简单，功能很轻。