Markdown文件编写方式
前言
躺平几个月没有写过博客了,趁着上班摸鱼有空,也为了以后写博客不用再搜,就把Markdown文件编写格式记下来,找找写博客的感觉同时也为以后省点事。
起因:
因为现在的前端基本上都用上了前端构建工具,难免要写一些readme等等的说明性文件,但是这样的文件一般都是 .md 的文件,编写的语法自然跟其他格式的文件有所区别,置于为什么要用这种格式的文件,不要问我,我也不知道,大家都这么用,跟着用就对了,本文基本是从网上找来的,仅供参考!
正文:
1、标题的几种写法:
第一种:
前面带#号,后面带文字,分别表示h1-h6,且只到h6,而且h1下面会有一条横线,注意,#号后面要有空格!!!
第二种
通过“======”或“——”,此方式应该只能表示一级和二级标题,而且=和-的数量没有限制,只要大于一个就行
第三种:
通过一对“#”、···、“######”包裹,这里的标题支持h1-h6,比较好理解,相当于标签闭合。注意,标题与 # 号要有空格
3种都可以使用,且可以混合使用,但是为了让页面标签的统一性,不建议混合使用,推荐使用第一种,比较简洁,全面
2、列表
我们都知道,列表分为有序列表和无序列表,下面直接展示2种列表的写法:
1 | * # · 无 |
无序列表可以用 * , + , — 来创建,实际上是转换成了ul>li ,所以使用哪个都可以,推荐使用 * 。
有序列表就相对简单一点,只有 · 这一种方式,注意,数字后面的点只能是英文的点,特别注意,有序列表的序号是根据第一行列表的数字顺序来的
3、区块引用
比如说想对某个部分做的内容做一些说明或者引用某某的话等,可以用这个语句
无序列表下方的便是引用,可以有多种用途,看你的需求了,用法就是在语句前面加一个”>” ,注意是英文的那个右尖括号,注意空格
例如
引用因为是一个区块,理论上是应该什么内容都可以放,比如说:标题,列表,引用等等,
此外还可嵌套使用
嵌套
上图可以看出,想要在上一次引用中嵌套一层引用,只需多加一个>,理论上可以无限嵌套,我就不整那么多了,注意:多层嵌套的>是不需要连续在一起的,只要在一行就可以了,中间允许有空格,但是为了好看,还是把排版搞好吧
4、华丽的分割线
分割线可以由* - _(星号,减号,底线)这3个符号的至少3个符号表示,注意至少要3个,且不需要连续,有空格也可以。效果如
为了代码的排版好看,自己定规则好一点。前面以及有用到过星号,所以建议用减号
5、链接
支持2种链接方式:行内式和参数式,不管是哪一种,链接文字都是用 [方括号] 来标记。
行内式的链接格式是:链接的文字放在[]中,链接地址放在随后的()中,举一反三,经常出现的列表链接就应该这样写:
“[foo]: http://example.com/ “Optional Title Here””
“[foo]: http://example.com/ ‘Optional Title Here’”
“[foo]: http://example.com/ (Optional Title Here)”
还支持这种写法,如果你不想混淆的话:
“[foo]: http://example.com/ “Optional Title Here””
参数式则是:
定义:[百度] https://www.baidu.com
使用:百度
6、图片
图片也有2种方式:行内式和参数式,
用法跟链接的基本一样,唯一的不同就是,图片前面要写一个!(这是必须的),没什么好说的
7、代码框
这个就比较重要了,很多时候都需要展示出一些代码
如果代码量比较少,只有单行的话,可以用单反引号包起来,如hello啊
要是多行这个就不行了,多行可以用三个反引号,如:
1 | 1 console.log("Hello World") #zzz |
多行用三个反引号,如果要写注释,可以在反引号后面写
8、表格
这个写的有点麻烦
我就不介绍啦~
9、强调
一个星号或者是一个下划线包起来,会转换为倾斜,如果是2个,会转换为加粗