文档利器-Markdown语法入门
文档利器-Markdown
目录
1、Markdwon 语法入门级简介
1.1、标题语法#1-#6
# H1
## H2
...
###### H6
效果如下:
H1
H2
...
H6
-
号的个数对应H1-H6标题的级别
-
注意#号后面要跟空格
-
根据文档规范,不太提倡超过
3级
的标题深度 -
然后注意,一个Markdown文件只能出现一个一级标题
1.2、列表
* 列表项1
* 列表项2
* 列表项3
效果如下:
-
列表项1
-
列表项2
-
列表项3
同样也可以这样来写:
- 列表项1
- 列表项2
- 列表项3
+ 列表
+ 列表
效果如下
- 列表项1
- 列表项2
- 列表项3
- 列表
- 列表
1.3、引用
在一篇优秀的文档之中,有自己精彩的表达,但是同样不乏引用别人的好词好句,为文章添砖加瓦。
在markdown中引用语法如下
> 后面接的是引用的内容
> 静夜思
床前明月光,
疑是地上霜。
举头望明月,
低头思故乡。
显示效果如下:
静夜思
床前明月光,
疑是地上霜。
举头望明月,
低头思故乡。
1.4、重点强调
有时候在一片文档中,需要强调一些重点的内容,可以这样
**中间是要强调的内容,显示的效果为加粗效果**
-- 斜体强调效果--
如:
中间是要强调的内容,显示的效果为加粗效果,是用两个星号包裹着
斜体
加粗斜体
删除线
1.5、链接LINK
这样实现链接效果
和这样实现链接效果
个人觉得下面实现效果更加美观
那么实现的如下:
[URL说明文字](URL地址)
例如:百度一下
[百度一下](http://www.baidu.com)
1.6、单词高亮
markdown
、Hello world
`hahha`
注意上面是反引号
一般是这样来突出关键词。
1.7、表格
有些时候我们需求对某些数据进行格式、或者按照表格方式来显示,这样能够更加清晰美观类显示数据就需要用到表格。
| 表头一| 表头二|
|---|---|
|表格数据一|表格<br>数据二|
显示如下:注意表头下面的格式
表头一 | 表头二 |
---|---|
表格数据一 | 表格数据二 |
还有一点就是,如果表格中数据比较多的话,我们需要换行显示,可以使用
来换行显示
表头一 | 表头二 |
---|---|
表格数据一 | 表格 数据二 |
表格中:号的使用,表格文字的对齐方式
如:
|左对齐、这是默认的|剧中显示|右对齐|
|:---|:---:|---:|
|左|中|右|
左对齐、这是默认的 | 剧中显示 | 右对齐 |
---|---|---|
左 | 中 | 右 |
良好地利用对齐方式,也是可以使显示格式更加美观
1.8、代码块
在IT行业人的博客或者文档中、代码块的出现肯定是极其常见的。
在上面我们也使用了不少。
下面是语法:
```java```:java表示该代码块属于java代码,这样的话,就能够实现代码高亮显示
Class A{
private int sid;
public void setSid(int sid){
this.sid = sid;
}
}
注意:在正文中、代码块前面需要加入一个空行。
1.9、图片
代码格式:
基础语法:
![图片title](图片URL)
注意是以!开头
高级用法
![图片说明][URL的id]
在文章最后指定URL的Id的链接地址
语法:
[URL的id]: URL地址
---
下面是关于图片大小、居中显示的一些设置
居中显示:<center></center>,但是有些编辑器可能不太支持
-w200: 表示宽度200px,在[]中书写
可以使用css代码来实现:
<img src="https://www.baidu.com/img/bd_logo1.png?where=super " width="80px" align="center">
width="80px":指定宽度
align="center":居中显示
在图片中有几点需要注意:由于图片的URL需要是互联网可以读取的,
所以在图片存取上,我们一般不存在与本地电脑中。需要存在互联网上,推荐七牛云、或者其他图床网站
2、文档规范
在书写文档时,我们有许多需要提倡的规范,这样能够时文档更加正规、合理。
- 1、一篇文档只能有一个一级标题
- 2、文档内容中不要出现太多截图
- 3、重要的内容加粗标注
- 4、代码使用代码框
- 5、引用要说明引用源