Skip to content

如何使用 Markdown

许多应用程序都支持 Markdown ,例如 GitHub, StackOverflow 等等;当然,也有许多优秀的 Markdown 编辑器,例如 Typora 等等

Note

虽然支持 Markdown 语法的工具很多,但是每个工具对于 Markdown 文档 的渲染效果都有差异;另外,一部分工具也支持更丰富的非标准语法,需要你仔细阅读对应的文档学习;当然,对于 Markdown 原生的标准语法,所有工具都是统一支持的。

在 Visual Studio Code 中使用 Markdown

Visual Studio Code(以下简称 VS Code) 是一款优秀的代码编辑器,可以直接到 官网 免费下载对应版本。由于 VS Code 本身支持 Markdown 语法,以及简单的渲染预览,因此你只要创建一个 .md 文件就可以开始你的 Markdown 之旅了!

VS Code 插件

可能你会觉得VS Code原生 Markdown 文档的功能过于简单,以下是一些丰富 Makrdown 功能的一些插件推荐

Markdown All in One

Markdown All in One

Markdown All in One 是一款集合大部分 Markdown 拓展功能的整合包插件,安装完后你可以通过 Ctrl+Shift+P 选择丰富的 Markdown 编辑命令,并且它支持数学公式、导出为 HTML 格式文件等常用功能

Markdown Preview Enhanced

Markdown Preview Enhanced

Markdown Preview Enhanced 也是一款集合大部分 Markdown 拓展功能的整合包插件,在预览和导出方面有更丰富的功能

Markdown Preview Mermaid Support

mermaid

Mermaid 是一种支持更多图表的扩展,它支持在markdown中画出 甘特图,类图,流程图,ER图等一系列图表,例如:

graph TD
    A[Christmas] -->|Get money| B(Go shopping)
    B --> C{Let me think}
    C -->|One| D[Laptop]
    C -->|Two| E[iPhone]
    C -->|Three| F[fa:fa-car Car]

具体语法可以参考 Mermaid Docs,完整介绍见 markdown扩展 一节

Marp for VS Code

marp

Marp 是一款能够通过 Markdown 制作幻灯片的扩展,完整介绍见 markdown扩展 一节

Markmap

markmap

Markmap 利用 Markdown 标题结构化的设计,可以将 Markdown 文档转化为思维导图,以另外一个角度阅读你的 Markdown 文档!

Markdown 在线小工具

在日常使用中,有一些好用的工具可以让你在书写 Markdown 时有更好的体验

LaTeX 公式编辑器

LaTeX 公式编辑器 是一款在线编辑 $\LaTeX$ 公式的网站,他支持你在线查看 $\LaTeX$ 符号对应的编码,支持拍照导出公式,支持导出图片,转义等功能;如果你喜欢在 Markdown 中使用 $\LaTeX$ 公式,那么使用这款小工具是一个不错的选择

latexlive

Mermaid 在线编辑器

Mermaid 在线编辑器 是 Mermaid 官方推出的在线编辑器,如果你不熟悉 mermaid 或者只是轻度使用 mermaid,那么可以考虑这个在线工具

mermaid editor

Markdown 表格编辑器

markdown 构建表格是一个比较复杂的过程,如果你想通过图形化的手段加快这一过程,可以使用 tablegenerator