.MD语法入门，教你写好readme文档
.md即markdown文件的基本常用编写语法,是一种快速标记、快速排版语言，现在很多前段项目中的说明文件readme等都是用.md文件编写的，而且很多企业也在在鼓励使用这种编辑方式，特别作为一个前端从业者更要学会使用这种语言。下面就简单和大家分享一些.md基本语法
题外话：我一般不安装markdown编辑器，直接用idea就可以编写。
一、基本符号：* - +. >
基本上所有的markdown标记都是基于这四个符号或组合，需要注意的是，如果以基本符号开头的标记，注意基本符号后有一个用于分割标记符和内容的空格。
二、标题
1.前面带#号，后面带文字，分别表示h1-h6,只到h6，而且h1下面会有一条横线
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
2.相当于标签闭合
# 一级标题 #
## 二级标题 ##
### 三级标题 ###
#### 四级标题 ####
##### 五级标题 #####
###### 六级标题 #####
三、列表
- 无序列表
//形式一
+ a
+ b
+ c
//形式二
- d
- e
- f
//形式三
* g
* h
* i
- 有序列表
//正常形式
1. abc
2. bcd
3. cde
//错序效果
2. fgh
3. ghi
5. hij
如图，注意，数字后面的点只能是英文的点，有序列表的序号是根据第一行列表的数字顺序来的，
错序列表的序号本来是序号是乱的， 但是还是显示 2 3 5
- 嵌套列表
//无序列表嵌套
+ 123+ abc+ bcd+ cde
+ 465
+ 789
//有序列表嵌套
1. abcd1. abcde2. abcde3. abcde
2. bcde
3. cdef
列表可以嵌套，使用时在嵌套列表前按 tab 或 空格 来缩进,去控制列表的层数
四、引用说明区块
对某个部分做的内容做一些说明或者引用某某的话等，可以用这个语法。
- 正常形式
> 引用内容、说明内容。在语句前面加一个 > ，注意是英文的那个右尖括号，注意空格，引用因为是一个区块，理论上是应该什么内容都可以放，比如说：标题，列表，引用等等。
- 嵌套区块
这里我只介绍一下我常用的方法，也是个人认为比较规范的一种方法，就是给区块的下一级区块多加一个右尖括号
> 一级引用
>> 二级引用
>>> 三级引用
>>>> 四级引用
>>>>> 五级引用
>>>>>> 六级引用
五、代码块
在发布一些技术文章会涉及展示代码的问题，这时候代码块就显得尤为重要。
- 少量代码，单行使用，直接用`包裹起来就行了
` shaoliangdaima,danhangshiyong `
- 大量代码，需要多行使用，用```包裹起来
```daliangdaima,xuyaoduohangshiyongdaliangdaima,xuyaoduohangshiyongdaliangdaima,xuyaoduohangshiyongdaliangdaima,xuyaoduohangshiyongdaliangdaima,xuyaoduohangshiyong```
六、链接
- 行内式
链接的文字放在[]中，链接地址放在随后的()中，链接也可以带title属性，链接地址后面空一格，然后用引号引起来
[简书](https://www.jianshu.com "创作你的创作"),
是一个创作社区,任何人均可以在其上进行创作。用户在简书上面可以方便的创作自己的作品,互相交流。
- 参数式
链接的文字放在[]中，链接地址放在随后的:后，链接地址后面空一格，然后用引号引起来
[简书]: https://www.jianshu.com "创作你的创作"
[简书]是一个创作社区,任何人均可以在其上进行创作。用户在简书上面可以方便的创作自己的作品,互相交流。
//参数定义的其他写法
[简书]: https://www.jianshu.com '创作你的创作'
[简书]: https://www.jianshu.com (创作你的创作)
[简书]: <https://www.jianshu.com> "创作你的创作"
七、图片
- 行内式
和链接的形式差不多，图片的名字放在[]中，图片地址放在随后的()中，title属性（图片地址后面空一格，然后用引号引起来）,注意的是[]前要加上!
- 参数式
图片的文字放在[]中，图片地址放在随后的:后，title属性（图片地址后面空一格，然后用引号引起来）,注意引用图片的时候在[]前要加上!
[my-logo.png]: https://upload-images.jianshu.io/upload_images/13623636-6d878e3d3ef63825.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240 "my-logo"
![my-logo.png]
//参数定义的其他写法
[my-logo.png]: https://upload-images.jianshu.io/upload_images/13623636-6d878e3d3ef63825.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240 'my-logo'
[my-logo.png]: https://upload-images.jianshu.io/upload_images/13623636-6d878e3d3ef63825.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240 (my-logo)
[my-logo.png]: <https://upload-images.jianshu.io/upload_images/13623636-6d878e3d3ef63825.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240> "my-logo"
八、分割线
分割线可以由* - _（星号，减号，底线）这3个符号的至少3个符号表示，注意至少要3个，且不需要连续，有空格也可以
---
- - -
------
***
* * *
******
___
_ _ _
______
九、其他
- 强调字体
一个星号或者是一个下划线包起来，会转换为<em>倾斜，如果是2个，会转换为<strong>加粗
*md*
**md**
_md_ __md__
- 转义
基本上和js转义一样,\加需要转义的字符
\\
\*
\+
\-
\`
\_
- 删除线
用~~把需要显示删除线的字符包裹起来
~~删除~~
十、表格
//例子一
|123|234|345|
|:-|:-:|-:|
|abc|bcd|cde|
|abc|bcd|cde|
|abc|bcd|cde|
//例子二
|123|234|345|
|:---|:---:|---:|
|abc|bcd|cde|
|abc|bcd|cde|
|abc|bcd|cde|
//例子三
123|234|345
:-|:-:|-:
abc|bcd|cde
abc|bcd|cde
abc|bcd|cde
上面三个例子的效果一样，由此可得：
1. 表格的格式不一定要对的非常起，但是为了良好的变成风格，尽量对齐是最好的
2. 分割线后面的冒号表示对齐方式，写在左边表示左对齐，右边为右对齐，两边都写表示居中
.MD语法入门，教你写好readme文档相关推荐
- 经典好文！手把手教你写Android项目文档，小白也能看明白
开头 无论你是在校的大学生,还是职场人,这篇文章都适合你 文章末附带资深架构师必须掌握的技能 1. 我们生活的每天都面临着很严重的挑战 虽然目前看起来我们都在做着自己的事情,一切在顺利的进行着,但是, ...
- 程序员如何技术划水，手把手教你写Android项目文档，绝对干货
安卓开发大军浩浩荡荡,经过近十年的发展,Android技术优化日异月新,如今Android 11.0 已经发布,Android系统性能也已经非常流畅,可以在体验上完全媲美iOS. 但是,到了各大厂商手 ...
- 手把手教你写Android项目文档，醍醐灌顶！
前言 今天想停下代码,写点脑袋里不断浮现出来的一些看法. 也就是最近在微博和知乎上老看到"互联网寒冬"的说法.要么是看到啥公司薪水无法如期发放了,要么是看到别人说什么"裁 ...
- 真牛皮！手把手教你写Android项目文档，内含福利
概述 想了很久怎么样可以让文章的标题不那么悲观,但是各种文案都在我脑海里面不断的被否定,要么是不那么抓眼球,要么是立意不匹配.最后想了想,这个标题是真的符合我最近的感悟. 希望看过文章,能有同感的朋友 ...
- 如何写一个优秀的GitHub项目README文档？
今天给大家介绍一个Github上的README文档写作教程模版,该模版目前获得6634颗星星,2296Fork,相对而言,还是比较得到大家认可的.不花哨,不别出心裁,一个比较实用的,普适性的架子:所谓 ...
- 如何写个优秀的Github项目Readme文档？经典模版拿去不谢~
今天给大家介绍一个Github上的README文档写作教程模版,该模版目前获得6634颗星星,2296Fork,相对而言,还是比较得到大家认可的.不花哨,不别出心裁,一个比较实用的,普适性的架子:所谓 ...
- 学习笔记：利用markdown写readme文档 （Udacity学城）
周末逛知乎等资讯平台的时候,无意间了解到Udacity学城有一期关于利用markdown撰写readme文档的教程,想到CSDN博客也提供了markdown编辑功能,而自己到现在还不会用,看着自己写的 ...
- 技术人如何写好技术文档？
点击"开发者技术前线",选择"星标" 让一部分开发者看到未来 参加工作时间久一点的工程师应该有这样一个体会:自己平时代码写得再多再好,可一旦要用文档去描述或者表 ...
- 怎么才能写好技术文档？这是我的全部经验
▲ 点击上方"分布式实验室"关注公众号 回复"1"抽取纸质技术书 参加工作时间久一点的工程师应该有这样一个体会:自己平时代码写得再多再好,可一旦要用文档去描述或 ...
最新文章
- 妲己智能机器人开箱_王者荣耀：妲己第二款史诗限定皮肤周三上架，全局数字流特效一览...
- android与苹果平板生态,Android和Apple平板电脑的性价比比较
- Java8 HashMap实现原理探究
- 个php反序列化漏洞,PHP反序列化漏洞学习(一)
- java设置native内存大小_如何定位native内存泄露问题?
- SSAS-MDX#001 - MDX 基本结构
- php 获取浏览器时区,获取用户时区
- 如果在2008年用10万元投资腾讯，现在可以实现财务自由吗？
- CentOS6.8下安装xz命令
- 《剑指offer》青蛙跳台阶
- python基础（1）——简介与安装
- 投屏软件_五款良心投屏软件，将安卓iOS投射到大屏幕
- USB Server应于银企直连
- 以下内容被锁定不能编辑：mxh983 ph6527 zyt2538 zyt9276 zy2674 zyt4372 zyt8731 zyt2832求解
- ppm与LSB含义，换算
- Jupyterhub batchspawner on PBS
- 一位营销总监的辞职信（非常经典）
- Git 【fatal: The remote end hung up unexpectedly 问题】
- 基于Python实现的微信好友数据分析——抓取好友性别、位置、头像签名
- 实践《如何使用Seata保证Dubbo微服务间的一致性》