Markdown 添加注记文本

发表于 更新于 分类于 阅读次数：

在写文档的时候, 我有时会有这样的需求:

  • 标记一段重要的文本；
  • 这些文本可以归属为: 笔记 (note) , 警告 (warning) , 定义等等

我就很想要一个彩色的框框, 把这段文字给标注一下. 在 \(\LaTeX\)​​​ 中, 一般是用命令 \mdframed 实现. 然而在 Markdown 的标准语法中, 并没有注记文本这一功能.

一些特殊的 Markdown 解析器可以做到, 比如在 Github Markdown 解析器中插入下段标记:

image-20230928143727151

注记文本的功能也有人向 Typora 官方提出过, 不过 Typora 认为这一功能并不是必要的, 反而还会破坏 Markdown 语法的简洁性. 在 Github 上的 issue是这样说的:

This seems too far way from most markdown engines. We want keep markdown in typora simple, no extra learning costs if one already knows how to write markdown. So, we are less likely to add syntax support for this

一种替代的方法是是用 emoji 🎉. 这个是 stackflow 上提供的权宜之计. 比如说, 我想写一段笔记:

📓 笔记

这是一段笔记.

还可以吧, 要是引用框的颜色可以变变就更好了. 不然 Typora 的文档总显得灰头土脸的, 放到 hexo 博客上的文章也是单一的白色. 这时可以使用 html 标签 <div> </div> 来添加引用文本的背景色, 可是需要添加很长一段代码, 在 Typora 中不太实用:

Warning

London is the capital city of England. It is the most populous city in the United Kingdom, with a metropolitan area of over 13 million inhabitants.

但是这个颜色吧… 综上, 还是使用 emoji 的方式, 在 Typora 中表示段落文字的强调.

在写 hexo 博客的时候, 可以使用 tag 插件实现这一功能,

1
2
3
{% note [class] [no-icon] [summary] %}
Any content (support inline tags too).
{% endnote %}

变量说明如下:

  • [class] : Optional parameter. Supported values: default | primary | success | info | warning | danger.
  • [no-icon] : Optional parameter. Disable icon in note.
  • [summary] : Optional parameter. Optional summary of the note.

效果图为

image-20240406093726500

除此之外

探索 Markdown 段落标记文字的时候, 发现它可以插入 html 标签, 来实现一些之前没想到过的功能. 更多内容可以参考官方文档, 以及 html 教学网站.

键盘标签 <kbd>

该标签可以插入在行内. 比如, 我想表示 VSCode 中「打开设置」快捷键: Ctrl+,.

总结标签 <summary>

I have keys but no locks. I have space but no room. You can enter but can't leave. What am I? 
 A keyboard. </details>