markdown
概述
设计理念
- Markdown 易于阅读,方便创作 web 文档,利于各平台无缝分发。
- Markdown 语法灵感最大的来源还是纯文本 email 的格式,完全由标点符号标签组成的纯文本。
- Markdown 文件应该以纯文本形式原样发布,不应该包含标记标签和格式化指令。
内联 HTML 语法
HTML 是一种发布格式,Markdown 是一种创作格式。
Markdown 语法集合比较小,只是 HTML 标签的一小部分。
对于 Markdown 中未包含的标签, 可以直接使用 HTML 标签,例如用 HTML <a>
标签替代 Markdown 的链接语法。
特殊字符自动转义
在 HTML 中, 有两个字符需要特殊对待: < 和 &,左尖括号用于起始标签。果你想将它们用作字面量, 你必须将它们转义为字符实体, 例如(<
)< 和 (&
)&。
行内语法讲解
注释的表述
代码法
1 | <div style="display: none">哈哈我是注释,不会在浏览器中显示。</div> |
这种方法 CSDN 不支持,但是直接转成 html 是可行的
html 注释
既然支持 html 语法,那也支持 html 注释,快捷键 command + /。
1 | <!--哈哈我是注释,不会在浏览器中显示。--> |
这里真的有注释···
hack 方法
hack 方法就是利用 markdown 的解析原理来实现注释的。
一般有的 markdown 解析器不支持上面的注释方法,这个时候就可以用 hack 方法。
hack 方法比上面 2 种方法稳定得多,但是语义化太差。
1 | [//]: # (哈哈我是最强注释,不会在浏览器中显示。) |
分级标题、任务列表
分级标题
1 | # 一级标题 |
任务列表
Markdown 语法:
- [ ] 任务一 未做任务 `- + 空格 + [ ]`
- [x] 任务二 已做任务 `- + 空格 + [x]`
效果如下:
任务一 未做任务 - + 空格 + [ ]
任务二 已做任务- + 空格 + [x]
缩进、换行、空行、对齐方式
首行缩进
不同特殊占位符所占空白是不一样大的。
 
或 
//全角 
或 
//半角
或 
//半角之半角(你还真的能看出来吗)- 或//啥也没有
换行
由于 markdown 编辑器的不同,可能在一行字后面,直接换行回车,也能实现换行,但是在有的地方,想要换行必须得在一行字后面空两个格子才行。
空行
在编辑的时候有多少个空行(只要这一行只有回车或者 space 没有其他的字符就算空行),在渲染之后,只隔着一行。
1 | <center>行中心对齐</center> |
行左对齐
行右对齐
斜体、粗体、删除线、下划线、背景高亮
1 | *斜体* 或 _斜体_ |
斜体 或 斜体
粗体 或 粗体
加粗斜体删除线
++下划线++
==背景高亮==
下划线
超链接、页内链接、自动链接、注脚
行内式
[]里写链接文字,()里写链接地址, ()中的””中可以为链接指定 title 属性,title 属性可加可不加。title 属性的效果是鼠标悬停在链接上会出现指定的 title 文字,链接地址与 title 前有一个空格。
1 | 百度一下 [百度](www.baidu.com) |
百度一下 百度
参考式
参考式超链接一般用在学术论文上面,或者另一种情况,如果某一个链接在文章中多处使用,那么使用引用 的方式创建链接将非常好,它可以让你对链接进行统一的管理。
脚注
在需要添加注脚的文字后加上脚注名字 [^注脚名字] ,称为加注。 然后在文本的任意位置(一般在最后)添加脚注,脚注前必须有对应的脚注名字。
经测试注脚与注脚之间必须空一行,不然会失效。成功后会发现,即使你没有把注脚写在文末,经 Markdown 转换后,也会自动归类到文章的最后。
锚点(页内超链接)
网页中,锚点其实就是页内超链接,也就是链接本文档内部的某些元素,实现当前页面中的跳转。比如我这里写下一个锚点,点击回到目录,就能跳转到目录。 在目录中点击这一节,就能跳过来。还有下一节的注脚。这些根本上都是用锚点来实现的,只支持在标题后插入锚点,其它地方无效。
自动链接
Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用<>包起来, Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样,例如:
1 | <http://example.com/>    |
页内跳转
1 | [内容](#编号) [跳转](#1.1) |
显示效果:
跳转
无序列表、有序列表、定义型列表
无序列表
使用 *,+,- 表示无序列表。
1 | * 无序列表项 一 |
- 无序列表项 一
- 无序列表项 二
- 无序列表项 三
有序列表
有序列表则使用数字接着一个英文句点。
- 有序列表项 一
- 有序列表项 二
- 有序列表项 三
- 有序列表项 一
- 有序列表项 二
- 有序列表项 三
定义型列表
语法说明:
定义型列表由名词和解释组成。空一行,然后一行写上定义,紧跟一行写上解释。解释的写法:紧跟一个缩进(Tab)
1 | Markdown |
插入图像
语法中图片 Alt 的意思是如果图片因为某些原因不能显示,就用定义的图片 Alt 文字来代替图片。 图片 Title 则和链接中的 Title 一样,表示鼠标悬停 y 于图片上时出现的文字。 Alt 和 Title 都不是必须的,可以省略,但建议写上。
1 | <center> <!--开始居中对齐--> |
多级引用
引用需要在被引用的文本前加上>符号和空格,允许多层嵌套,也允许你偷懒只在整个段落的第一行最前面加上 > 。
1 | >>> 请问 Markdwon 怎么用? - 小白 |
请问 Markdwon 怎么用? - 小白
自己看教程! - 愤青
教程在哪? - 小白
转义字符、字体、字号、颜色
- Markdown 中的转义字符为\,转义的有:
\ 反斜杠 ` 反引号 * 星号 _ 下划线
{} 大括号 [] 中括号 () 小括号
# 井号 + 加号 - 减号
. 英文句号 ! 感叹号
1 | <font face="黑体">我是黑体字</font> |
块语法讲解
内容目录
在段落中填写 [TOC] 以显示全文内容的目录结构。
代码块
对于程序员来说这个功能是必不可少的,插入程序代码的方式有两种,一种是利用缩进(Tab), 另一种是利用”`”符号(一般在 ESC 键下方)包裹代码。
行内式
1 | C语言里的函数 `scanf()` 怎么使用? |
C 语言里的函数 scanf()
怎么使用?
缩进式多行代码
- 缩进 4 个空格或是 1 个制表符
- 一个代码区块会一直持续到没有缩进的那一行(或是文件结尾)。
tags-plugin
1 | <figure class="highlight markdown"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br><span class="line">5</span><br></pre></td><td class="code"><pre><span class="line"><span class="section">#include &lt;stdio.h&gt;</span></span><br><span class="line">int main(void)</span><br><span class="line">{</span><br><span class="line"><span class="code"> printf(&#34;Hello world\n&#34;);</span></span><br><span class="line"><span class="code">}</span></span><br></pre></td></tr></table></figure> |
```
1 |
|
tags-plugin
1 |
|
```
1 | include <stdio.h> |
流程图
1 |
|
1 | graph LR |
1 | sequenceDiagram |
表格
- 不管是哪种方式,第一行为表头,第二行分隔表头和主体部分,第三行开始每一行为一个表格行。
- 列于列之间用管道符|隔开。原生方式的表格每一行的两边也要有管道符。
- 第二行还可以为不同的列指定对齐方向。默认为左对齐,在-右边加上:就右对齐。
- 左对齐, :-: 中心对齐,-: 右对齐
1 | | 学号 | 姓名 | 性别 | |
学号 | 姓名 | 性别 |
---|---|---|
—-: | :—: | :—- |
LaTeX 公式
表示行内公式
代码:
质能守恒方程可以用一个很简洁的方程式 来表达。
$E = m c^2$
分隔线
可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:
1 | --- |
HTML 原始码
在代码区块里面, & 、 < 和 > 会自动转成 HTML 实体,这样的方式让你非常容易使用 Markdown 插入范例用的 HTML 原始码,只需要复制贴上,剩下的 Markdown 都会帮你处理
第一个例子
1 | <div class="footer"> |
第一个例子
1 | <center> |
第三个例子
1 | <details> |
第一个例子
第一个例子
值班人员 | 星期一 | 星期二 | 星期三 |
---|---|---|---|
李强 | 张明 | 王平 |
第三个例子
展开查看
System.out.println("Hello to see U!");
特殊字
描述 | 字符的代码 |
---|---|
空格符 | |
小于号 | < |
大于号 | > |
和号 | & |
人民币 | ¥ |
版权 | © |
注册商标 | ® |
摄氏度 | °C |
正负号 | ± |
乘号 | × |
除号 | ÷ |
平方(上标 ²) | ² |
立方(上标 ³) | ³ |
6.1. Markdown 是一种纯文本标记语言 ↩
6.2. HyperText Markup Language 超文本标记语言 ↩