跳转至

格式

记录包括扩展语法在内的格式用法,以便提高文档可读性以及吸引力。

优先考虑在 Material for MkDocs 呈现,同时尽可能保证兼容 Github 预览

基本文本样式

源码 预览
粗体 **粗体** 粗体
斜体 _斜体_ 斜体
粗斜体 ***粗斜体*** 粗斜体
删除线 ~~删除线~~ 删除线
高亮 <mark>高亮</mark> 高亮
下划线 <ins>下划线</ins> 下划线
上标 上<sup>标</sup>
下标 下<sub>标</sub>

引用、提示、警告等

原生 Markdown 引用格式

北越部队包围了城市,MACV 不得已只好销毁证据,那个俄国叛逃者必死无疑。

告示

详见 Admonitions - Material for MkDocs,Github 预览不支持。

Quote

北越部队包围了城市,MACV 不得已只好销毁证据,那个俄国叛逃者必死无疑。

Tip

北越部队包围了城市,MACV 不得已只好销毁证据,那个俄国叛逃者必死无疑。

网格

详见 Grids - Material for MkDocs,Github 预览不支持。

  • 方格1


    内容

  • 方格2


    内容

图片

使用 Markdown 原生语法,MkDocs 的方法在 Github 预览中可读性不佳,相较于告示和网格更难以接受。