Md实用标签
Md实用标签
目录
Md实用标签
前言:慎用HTML标签
【注意】
写作时优先使用Md自带的语法,少用HTML标签。几个原因:
实在想要极度样式丰富,那为什么不直接使用富文本编辑呢
应当重视实际内容与效率
Markdown语法简单就是为了把更多精力放在 “写” 上,不要本末倒置,花 “大精力” 去修饰文章
除非在有 “工具栏” 的情况下,不影响写作效率时,可以适当使用(例如Ob 思源等有工具栏插件、掘金等一些博客也会自带工具栏)
语法简单与样式简单
过多地使用样式,反而容易找不到重点。一篇文章应该使用较少的几种样式,减少地去圈重点(处处重点等于没重点)
当然,在一些情况下,使用HTML标签去丰富样式是有利的。比如:
- 想要丰富的格式,但某些平台只能使用Markdwon写作时
- 产品级文档(不是指技术文档,那种也没必要,除非你有专门的部门去干。主要是单页的主文档)
- 比如某个项目的介绍文档,比如简历等(但这些一般都用富文本格式吧)
- 这时可以减少对效率的极致需求,花多一些精力去对文档进行润色,是合适的
- 某些专题的笔记
- 比如在写注音笔记、或翻译来的文档时,ruby + rt 标签会很有用,可以保留原单词的同时又可以不让这些单词影响阅读体验
- 比如在软件介绍时,使用 kbd 标签(最好加个样式),看起来更直观
总之,合理使用就好
可使用
标签类
标签 | 作用 | 使用建议 |
---|---|---|
br | 换行 换行 | 比如表格内换行就使用上了 |
Sytle类
Sytle内容 | 作用 | 使用建议 |
---|---|---|
图片高宽控制 或者缩放 | 我主要是在表格内使用。让他们的高或宽相同(固定px) 完美解决对齐问题(图片本来一大一小) 图片缩放也行,比如50%,但一般我会给固定大小而非百分比 | |
右浮动 float或align | 右 右 | 用得不多 |
用标签代替扩展语法
标签替代方案
有对应的扩展语法,就说明有相关的使用需求。 与html标签相比,扩展语法的优点是写得快,缺点是不如html标签兼容性好。
扩展语法 | HTML 代替标签 | 效果 |
---|---|---|
[[双链]] | —— | —— |
$内联公式$ | & 转义、unicdoe强行输出。这个没必要转HTML标签的,还是能直接用的 | —— |
==高亮== | mark | mark高亮 |
Ty 上标^2^ | sup | 上标2 |
Ty 下标~2~ | sub | 下标2 |
%%ob注释%% | <!-- html注释 --> | |
ob table extended 插件表格 | table(不要手动写,有在线转化工具,随便搜一下就有) | 略 |
列表折叠/callout默认折叠 | details | 我是一段被隐藏的内容 |
兼容性
(以下表头缩写分别为:Obsidian、Typora、CSDN、掘金、Github、用于代替的HTML标签。) (第一个方块表示对扩展语法的兼容性,第二个方块表示替换成HTML标签后的兼容性,没有或黑色方块表示就没有没有该扩展语法的替换方案)
扩展语法 | Ob | Ty | CS | 掘 | Gi |
---|---|---|---|---|---|
双链 | 🟩 | 🟥 | 🟥 | 🟥 | 🟥 |
内联公式 | 🟩 | 🟩 | 🟩 | 🟩 | 🟥 |
高亮 | 🟩🟩 | 🟩🟩 | 🟩🟩 | 🟥🟩 | 🟥🟥 |
Ty上下标 | 🟥🟩 | 🟩🟩 | 🟥🟩 | 🟥🟩 | 🟥🟩 |
ob 注释 | 🟩🟩 | 🟥🟩 | 🟥🟩 | 🟥🟩 | 🟥🟩 |
ob table extended | 🟩🟩 | 🟥🟩 | 🟥🟩 | 🟥🟩 | 🟥🟩 |
列表折叠/callout默认折叠 | 🟩🟩 | 🟥🟩 | 🟥🟥 | 🟥🟩 | 🟥🟩 |
总结(扩展语法 or HTML标签)
内联公式和高亮虽然属于md的扩展语法,但兼容性较好,而且就算不支持也不会有什么严重后果,可以放心使用。
其他扩展语法,如果有将笔记分享到其他平台,需要考虑兼容性问题的,均建议优先使用html标签作为替换方案
像双链这种即是扩展语法,又没替换方案的,就没办法了
details标签补充
效果:
我是一段被隐藏的内容
不兼容的情况(如CSDN)表现为默认展开,不需要担心隐藏内容消失
使用建议:
“可折叠” 和 “默认折叠” 不同,列表折叠无法确保别人查看时是默认折叠状态 (Ob我觉得他是用缓存来保存这个折叠状态的)
真正意义上的 “默认折叠” 我一般用callout语法(admonition插件)
> [!note]- > 默认折叠的隐藏内容
无论是列表折叠还是callout默认折叠,兼容性都不好,基本上只有Ob能用。
Detail标签只适合使用在你要将笔记发布到其他社区或博客平台上,并且想要让一段内容默认隐藏的场景。
对于折叠敏感内容来说还是挺好用的,比如百科的防剧透和敏感折叠那种用的比较多。 萌娘百科(但这个应该是富文本)甚至使用了一个
.heimu
的class用来表示一种鼠标悬浮上去才会显示的样式,例如:<span title="你知道的太多了" class="heimu">后期集中在剧场版</span>
但总体而言场景需求较少
特殊情况使用
一般是专题笔记才用,如没必要勿使用
标签 | 作用 | 使用建议 |
---|---|---|
ruby + rt | 国家Nation国家Nation国家 或 国家Nation国家Nation国家 | 技术翻译文档里比较常见的(Typora复制有bug) (这个最好字体在18px以上效果较好) |
kbd | Ctrl + C Ctrl Shift + V | KBD即键盘(Keyboard)的缩写,主要是快捷键用 觉得原生的样式有点一般的,也可以调整一下css |
u | 下滑线 | |
center | (正文生效) | 非必要,勿使用 |
abbr | k8s | 缩写,可以为一些缩写添加注释 |
兼容性 (以下表头缩写分别为:Obsidian、Typora、CSDN、掘金、Github、用于代替的HTML标签。)
扩展语法 | Ob | Ty | CS | 掘 | Gi |
---|---|---|---|---|---|
ruby + rt | 🟩 | 🟩 | 🟩 | 🟩 | 🟩 |
kbd | 🟩 | 🟩 | 🟩 | 🟥 | 🟩 |
u | 🟩 | 🟩 | 🟩 | 🟥 | 🟥 |
center | 🟩 | 🟩 | 🟩 | 🟥 | 🟥 |
abbr | 🟩 | 🟩 | 🟩 | 🟩 | 🟥 |
不建议使用
一般不建议
标签 | 作用 | 使用建议 |
---|---|---|
font + style样式 主要是face size color | 看到有的人比较喜欢使用这个。 其实还是可以用,如果有工具栏,并且能保证不会以纯文本方式编辑。 反正我不喜欢 | |
class | 自定义 | 自定义了一个class,来使用自定义样式。 范例:例如萌娘百科的heimu class用来表示一种鼠标悬浮上去才会显示的样式 |
没有任何用的必要
一般不使用这些标签,因为 md 自身有更简单的写法
标签 | 作用 | 代替 |
---|---|---|
b | 强调 | 用md自身语法代替 |
i em | 斜体 强调 | 用md自身语法代替 (有区别的,md斜体用的是em) |
del | ||
h1 (表格外有效) | <h1>1级标题</h1> | # 1级标题 |
h2 (表格外有效) | <h2>2级标题2</h2> | ## 2级标题 |
h3 (表格外有效) | <h3>3级标题1</h3> | ### 3级标题 |
…… | …… | …… |
纯炫技,毫无卵用
pre+code
可以把源码包含````dataviewjs`之类的直接包含在里面显示出来, 方便复制……但是,不如原生的
<pre><code>内容</code</pre>>
内容
兼容性
标签 | Ob | Ty | CS | 掘 | Gi |
---|---|---|---|---|---|
progress | 🟩 但原生的就可复制 | 🟥 | 🟥 但原生的就可复制 | 🟥 | 🟩 但原生的就可复制 |
progress
显示进度条,而且兼容性很差。
标签 | Ob | Ty | CS | 掘 | Gi |
---|---|---|---|---|---|
progress | 🟩 | 🟥 | 🟥 | 🟥 | 🟥 |
效果:
这个兼容性已经很差了,后面的那几个基本上兼容性都不会好。后面的我就不一一地去试兼容性了
figure
可以给图片一个文字说明。效果:
area
为图片提供点击热区,可以自己规定一张图的哪些区域可点击;一般配合map使用。效果: