一、前言
- 由于有些语法无法在博客园展示,推荐使用Typora可全功能演示MarkDown语法。
下载地址:https://www.typora.io/
推荐使用jupyter,使用方法:https://www.cnblogs.com/springsnow/p/12030654.html
- 基础markdown语法参考:https://www.appinn.com/markdown/
- markdown数学公式大全,https://www.cnblogs.com/nickchen121/p/11746655.html
- 插入数学公式markdown语法参考:https://www.zybuluo.com/codeep/note/163962
Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。 --摘自百度百科
没想到一向不太靠谱的百度百科这次竟有了如此精辟的解释。之前项目一直使用word
撰写文档,有比较大的弊病:
- 只能对纯文本文件进行版本控制,而word是二进制格式
- 格式繁杂,经常需要中断写作来控制格式
- 代码与文档分离,给写文档造成更大的阻力
而假如单纯的使用txt,就没有一点格式了,用html虽然既有格式又能加入版本控制,但是需要花费较多的时间在标签上,而且标签占了文档的较大百分比,不易阅读。
所以,最终的解决方案就是 **Markdown** ,作为一种轻量级的标记语言,能在非常短的时间内掌握。而且不仅可以用于写文档,还可以写博客、写简书、做一些随手笔记。
Markdown文件以.md结尾,可以导出为html和PDF(需要使用的工具支持)。它是一种语法(个人认为是简化版的html),但是和html不同的是,各种解析器对其会有不同的表现。比如我的IDEA Markdown插件会把分割线显示成一条细灰线,Cmd Markdown则是显示一条虚线。所以建议保持使用一种Markdown工具和尽量使用标准语法。
二、Markdown基本语法
1、标题
如果一段文字被定义为标题,只要在这段文字前加# 号即可。
总共六级标题,建议在#号后加一个空格,这是最标准的 Markdown 语法。
代码:
# 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 最小只有六级标题
2、换行符
用回车表示换行,空行表示一个新段落。
dfasdfasdfs adfsa aa adf
新行
新行新段落
3、粗体
用**(一个星号)包含一段文本就是粗体的语法,用*(一个星号)包含一段文本就是斜体的语法。
代码:
**我被加粗了**
效果:
我被加粗了
4、斜体
用*(一个星号) 或者_(一个下划线)包含一段文本表示斜体
代码:
*我倾斜了*
效果:
我倾斜了
5、删除线
使用~~包含一段文本。
~~删除线~~
效果如下:
删除线
6、列表
1、有序列表
有序列表:在文字前加1. 2. 3. ,符号和文字之间加上一个字符的空格。
代码:
1. one 2. two 3. three
效果:
- one
- two
- three
2、无序列表
无序列表:在文字前加上 -(减号) 或 *(星号) 或 +(加号)号即可。
代码:
* one * two * three
效果:
- one
- two
- three
7、 引用
如果你需要引用一小段别处的句子,那么就要用引用的格式。
在文字前加> 号即可。(注意>后的空格)
代码:
> hello markdown!
效果:
hello markdown!
8、 特殊显示(`式)
标记代码使用反引号,用`包含一段文本。
代码:
`print('hello nick')`
效果:
print('hello nick')
9、 代码区域(```式)
用```包含一段文本。
代码:
```python print('hello nick') ```
效果:
print('hello nick')
10、链接
用<(尖括号)包含一个URL。把URL作为链接插入。
11、带描述的链接
[链接描述](链接地址)
代码:
[百度](https://www.baidu.com "alt描述信息")
效果:
12、图片
插入链接与插入图片的语法很像,区别在一个 !号。
代码:
![百度logo](https://www.baidu.com/img/baidu_jgylogo3.gif 'alt描述信息')
效果:
13、带图片的链接
代码:
[![百度logo](https://www.baidu.com/img/baidu_jgylogo3.gif '描述信息')](http://www.baidu.com)
效果:
14、分割线
输入***
或---
再按回车即可绘制一条水平线,如下:
代码:
---
15、表格
第一行为标题,以|隔开。第二行必须得有,并且第二行的冒号代表对齐格式,以下格式分别为居中;右对齐;左对齐)
name | age | sex :-: | :- | -: tony |20 |男 lucy |18 |女
效果:
name | age | sex |
---|---|---|
tony | 20 | 男 |
lucy | 18 | 女 |
16、表情符号
:smile:
:smile :(注意为:是英文的冒号)
:smile:
17、特殊符号
用来转义,表示文本中的markdown符号