MarkDown 学习笔记
一,兼容 HTML
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。不需要额外标注这是 HTML 或是 Markdown;只要直接加标签就可以了。
要制约的只有一些 HTML区块元素――比如<div>、<table>、<p>
等标签,必须在前后加上空行与其它内容区隔开,还要求它们的开始标签与结尾标签不能用制表符或空格来缩进。Markdown 的生成器有足够智能,不会在 HTML 区块标签外加上不必要的 p 标签。
例子如下,在 Markdown 文件里加上一段 HTML 表格:这是一个普通段落。
表格 | 表格 | 表格 |
请注意,在 HTML 区块标签间的 Markdown 格式语法将不会被处理.。但Markdown 语法在 HTML 区段标签间是有效的。
HTML的区段(行内)标签如<span>、<cite>、<del>
可以在 Markdown 的段落、列表或是标题里随意使用。依照个人习惯,甚至可以不用 Markdown 格式,而直接采用 HTML 标签来格式化。举例说明:如果比较喜欢 HTML 的 <img>
标签,可以直接使用这些标签,而不用 Markdown
二,特殊字符自动转换
< 可用 < ; > 可用 > ;
& 可用 & ;
© 可用 © ; 版权符号
三,区块元素
1. 段落和换行
插入处先按入两个以上的空格然后回车。也可用 <br/>
标签
2. 标题
在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶
3. 区块引用
Markdown 标记区块引用是使用类似 email 中用 > 的引用方式。在每行的最前面加上 > 。Markdown 也允许你偷懒只在整个段落的第一行最前面加上 >。区块引用可以嵌套(例如:引用内的引用),只要根据层次加上不同数量的 >。
例如:
This is the first level of quoting.
This is nested blockquote.
Back to the first level.
引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等
例如:
这是一个标题。
- 这是第一行列表项。
- 这是第二行列表项。
给出一些例子代码:
return shell_exec("echo $input | $markdown_script");
4. 列表
无序列表使用星号、加号或是减号作为列表标记
例如:
- Red
- Green
- Blue
有序列表则使用数字接着一个英文句点
5. 代码区块
要在 Markdown 中建立代码区块很简单,只要简单地缩进 4 个空格或是 1 个制表符就可以
也可用三个反引号(```)包裹
6. 分隔线
你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。
四,区段元素
1. 链接
要建立一个行内式的链接,只要在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如:
This is an example inline link.
2. 强调
Markdown 使用星号(*)和底线(_)作为标记强调字词的符号,一个斜体,两个粗体,三个粗斜体,例如:
斜体
斜体
粗体
粗体
粗斜体
粗斜体
符号(),一个下沉,两个删除
~下沉效果删除效果
标记符号(=),两个变黄显示
==变黄显示==
下划线符号(<u>
)
带下划线文本
如果要在文字前后直接插入普通的星号或底线,你可以用反斜线:
*this text is surrounded by literal asterisks*
3. 代码
如果要标记一小段行内代码,你可以用反引号把它包起来(`),例如:
Use the printf()
function.
如果要在代码区段内插入反引号,你可以用多个反引号来开启和结束代码区段:There is a literal backtick (`) here.
代码区段的起始和结束端都可以放入一个空白,起始端后面一个,结束端前面一个,这样你就可以在区段的一开始就插入反引号:
A backtick-delimited string in a code span: `foo`
4. 图片
行内式的图片语法看起来像是:
五,其它
1. 反斜杠
Markdown 可以利用反斜杠来插入一些在语法中有其它意义的符号
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
\ 反斜线
` 反引号
* 星号
_ 底线
{} 花括号
[] 方括号
() 括弧
# 井字号
+ 加号
- 减号
. 英文句点
! 惊叹号
2. 自动链接
一般网址的链接文字就和链接地址一样,例如:http://example.com/
3. 选择框
- 空框
- 已选择
4. 表格
header 1 | header 2 |
---|---|
row 1 col 1 | row 1 col 2 |
row 2 col 1 | row 2 col 2 |
左对齐左对齐 | 右对齐右对齐 | 居中对齐居中对齐 |
---|---|---|
单元格 | 单元格 | 单元格 |
单元格 | 单元格 | 单元格 |
5. 脚注
脚注是对文本的补充说明。
创建脚注格式类似这样 ^脚注。
6. 流程图
- 横向流程图源码格式:
graph LR
A[方形] -->B(圆角)
B --> C{条件a}
C -->|a=1| D((圆形))
C ---|a=2| E[直箭头]
F[横向流程图]
- 竖向流程图源码格式:
graph TD
A[方形] --> B(圆角)
B --> C{条件a}
C --> |a=1| D((圆形))
C --> |a=2| E[插入文本箭头]
F[竖向流程图]
7. 序列图
sequenceDiagram
A->>B: How are you?
B->>A: Great!
8. 甘特图
gantt
dateFormat YYYY-MM-DD
title 产品计划表
section 初期阶段
明确需求: 2020-02-25, 5d
section 中期阶段
跟进开发: 2020-03-01, 31d
section 后期阶段
走查测试: 2020-04-01, 10d
9. 书写数学公式
E = mc^2