Markdown 使用指南 - 语法速查手册

本贴最后更新于 237 天前,其中的信息可能已经时移世异

总览

本文仅列出最常用的 Markdown 语法,未覆盖的细节请参考基础语法扩展语法

基础语法

下列元素语法是所有 Markdown 引擎都支持的,可以放心使用。

元素 Markdown 语法
标题 # 一级标题## 二级标题
加粗 **粗体文本**
强调 *斜体文本*
块引用 > 引用内容
有序列表 1. 列表项
无序列表 - 列表项
代码 代码
分隔线 ---
超链接 [B3log](https://b3log.org)
图片 ![B3log Logo](https://static.b3log.org/images/brand/b3log-128.png)

扩展语法

下列元素语法并不是所有 Markdown 引擎都支持,使用前请进行确认。

元素 Markdown 语法
表格 | Syntax | Description |
| ------ | ---------- |
| Header | Title |
| Paragraph | Text |
围栏代码块 ```
脚注 这里是一个脚注引用[^1]
标题 ID ### 这是一个标题 {#custom-id}
删除线 ~~地球是平的。~~
任务列表 - [x] 待办事项一

赞助商 我要投放

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
  • liwuming

    你好,vditor 可以增加一个 info、warning、tips 标签,就好比:::info 内容区域 info 的渲染结果是 <blockquote class="info">内容</blockquote>

    1 回复
  • 88250
    作者

    谢谢建议,请问这个有什么其他参考的地方吗?主要用意是方便写文档吧?

  • StephenZhang

    请问 Vditor 是否计划支持 MathJax 或者 KaTex 这样的 LaTeX 渲染器呢?如果博客中要写数学公式的话,这将很有帮助 🙏

    1 回复
  • 88250
    作者

    已经支持,和其他 Markdown 编辑器基本一个用法,数学公式块使用 $$,内联数学公式使用 $

    1 回复
  • StephenZhang

    试了一下,数学公式确实是支持的,与 Typora、Markdown Preview Enhanced 等不同的是,$ 后似乎必须有一个空格才能渲染;除此之外,在 Solo 中,脚注的语法似乎不起作用,请问应该怎么解决……?

    1 回复
  • 88250
    作者

    请看 Solo 用户指南 FAQ。

    1 回复
  • StephenZhang

    Thank u, 问题解决!

  • PeterChu

    脚注的用法学习:

    写法:

    实例1[^1]
    [^1]:xxxxxxx
    

    效果:

    实例 11


    1. xxxxxxx

请输入回帖内容 ...