ToB企服应用市场:ToB评测及商务社交产业平台

标题: .MD语法入门，教你写好readme文档 [打印本页]
作者: 自由的羽毛    时间: 2022-10-27 08:49
标题: .MD语法入门，教你写好readme文档
.md即markdown文件的基本常用编写语法,是一种快速标记、快速排版语言，现在很多前段项目中的说明文件readme等都是用.md文件编写的，而且很多企业也在在鼓励使用这种编辑方式，特别作为一个前端从业者更要学会使用这种语言。下面就简单和大家分享一些.md基本语法

题外话：我一般不安装markdown编辑器，直接用idea就可以编写。

一、基本符号：* - +. >
基本上所有的markdown标记都是基于这四个符号或组合，需要注意的是，如果以基本符号开头的标记，注意基本符号后有一个用于分割标记符和内容的空格。
二、标题
1.前面带#号，后面带文字，分别表示h1-h6,只到h6，而且h1下面会有一条横线
  1. # 一级标题
  2. ## 二级标题
  3. ### 三级标题
  4. #### 四级标题
  5. ##### 五级标题
  6. ###### 六级标题
复制代码
2.相当于标签闭合
  1. # 一级标题 #
  2. ## 二级标题 ##
  3. ### 三级标题 ###
  4. #### 四级标题 ####
  5. ##### 五级标题 #####
  6. ###### 六级标题 #####
复制代码

三、列表
  1. //形式一
  2. + a
  3. + b
  4. + c
  5. //形式二
  6. - d
  7. - e
  8. - f
  9. //形式三
  10. * g
  11. * h
  12. * i
复制代码
  1. //正常形式
  2. 1. abc
  3. 2. bcd
  4. 3. cde
  5. //错序效果
  6. 2. fgh
  7. 3. ghi
  8. 5. hij
复制代码
如图，注意，数字后面的点只能是英文的点，有序列表的序号是根据第一行列表的数字顺序来的，
错序列表的序号本来是序号是乱的， 但是还是显示 2 3 5
  1. //无序列表嵌套
  2. + 123
  3.     + abc
  4.     + bcd
  5.     + cde
  6. + 465
  7. + 789
  8. //有序列表嵌套
  9. 1. abcd
  10.     1. abcde
  11.     2. abcde
  12.     3. abcde
  13. 2. bcde
  14. 3. cdef
复制代码
  列表可以嵌套，使用时在嵌套列表前按 tab 或 空格 来缩进,去控制列表的层数
四、引用说明区块
对某个部分做的内容做一些说明或者引用某某的话等，可以用这个语法。
  1. > 引用内容、说明内容。在语句前面加一个 > ，注意是英文的那个右尖括号，注意空格，引用因为是一个区块，理论上是应该什么内容都可以放，比如说：标题，列表，引用等等。
复制代码
  1. > 一级引用
  2. >> 二级引用
  3. >>> 三级引用
  4. >>>> 四级引用
  5. >>>>> 五级引用
  6. >>>>>> 六级引用
复制代码
五、代码块
在发布一些技术文章会涉及展示代码的问题，这时候代码块就显得尤为重要。
  1. ` shaoliangdaima,danhangshiyong `
复制代码
  1.     ```
  2.         daliangdaima,xuyaoduohangshiyong
  3.         daliangdaima,xuyaoduohangshiyong
  4.         daliangdaima,xuyaoduohangshiyong
  5.         daliangdaima,xuyaoduohangshiyong
  6.         daliangdaima,xuyaoduohangshiyong
  7.     ```
复制代码
六、链接

  1. [简书](https://www.jianshu.com "创作你的创作"),
  2. 是一个创作社区,任何人均可以在其上进行创作。用户在简书上面可以方便的创作自己的作品,互相交流。
复制代码
  1. [简书]: https://www.jianshu.com "创作你的创作"
  2. [简书]是一个创作社区,任何人均可以在其上进行创作。用户在简书上面可以方便的创作自己的作品,互相交流。
  3. //参数定义的其他写法
  4. [简书]: https://www.jianshu.com '创作你的创作'
  5. [简书]: https://www.jianshu.com (创作你的创作)
  6. [简书]: <https://www.jianshu.com> "创作你的创作"
复制代码
七、图片

  1. ![my-logo.png](https://upload-images.jianshu.io/upload_images/13623636-6d878e3d3ef63825.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240 "my-logo")
复制代码
  1. [my-logo.png]: https://upload-images.jianshu.io/upload_images/13623636-6d878e3d3ef63825.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240 "my-logo"
  2. ![my-logo.png]
  3. //参数定义的其他写法
  4. [my-logo.png]: https://upload-images.jianshu.io/upload_images/13623636-6d878e3d3ef63825.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240 'my-logo'
  5. [my-logo.png]: https://upload-images.jianshu.io/upload_images/13623636-6d878e3d3ef63825.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240 (my-logo)
  6. [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个，且不需要连续，有空格也可以
  1. ---
  2. - - -
  3. ------
  4. ***
  5. * * *
  6. ******
  7. ___
  8. _ _ _
  9. ______
复制代码
九、其他

  1. *md*   
  2. **md**
  3. _md_   
  4. __md__
复制代码
  1. \\
  2. \*
  3. \+
  4. \-
  5. \`
  6. \_
复制代码
  1. ~~删除~~
复制代码
十、表格
  1. //例子一
  2. |123|234|345|
  3. |:-|:-:|-:|
  4. |abc|bcd|cde|
  5. |abc|bcd|cde|
  6. |abc|bcd|cde|
  7. //例子二
  8. |123|234|345|
  9. |:---|:---:|---:|
  10. |abc|bcd|cde|
  11. |abc|bcd|cde|
  12. |abc|bcd|cde|
  13. //例子三
  14. 123|234|345
  15. :-|:-:|-:
  16. abc|bcd|cde
  17. abc|bcd|cde
  18. abc|bcd|cde
复制代码
  上面三个例子的效果一样，由此可得：
1. 表格的格式不一定要对的非常起，但是为了良好的变成风格，尽量对齐是最好的
2. 分割线后面的冒号表示对齐方式，写在左边表示左对齐，右边为右对齐，两边都写表示居中





 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！



欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4