如何书写.md格式文档

md即markdown,百度的解释:Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。

总是可以自github上看到有一个这样说明性的描述文件。

现在的前端基本上都用上了前端构建工具,那就难免要写一些readme等等的说明性文件。

但是这样的文件一般都是.md的文件,编写的语法自然跟其他格式的文件有所区别,置于为什么要用这种格式的文件,我也不知道,大家好像都这么用,跟着用就对了!

 

写.md的好工具,Typora是一款轻便简洁的Markdown编辑器,支持即时渲染技术,这也是与其他Markdown编辑器最显著的区别。即时渲染使得你写Markdown就想是写Word文档一样流畅自如,不像其他编辑器的有编辑栏和显示栏。简言之,好用,但是应该学着记一下一些常用的,不要太依赖!

一、标题

标题其实和HTML中的h系列很像,想要设置为标题的文字前面加#来表示
一个#是一级标题,二个#是二级标题,以此类推。支持六级标题。

注:标准语法一般在#后跟个空格再写文字,

示例:

# 这是一级标题
## 这是二级标题
### 这是三级标题
#### 这是四级标题
##### 这是五级标题
###### 这是六级标题

效果如下:

这是一级标题

这是二级标题

这是三级标题

这是四级标题

这是五级标题
这是六级标题

二、字体

  • 加粗

要加粗的文字左右分别用两个*号包起来

  • 斜体

要倾斜的文字左右分别用一个*号或者用_包起来

  • 斜体加粗

要倾斜和加粗的文字左右分别用三个*号包起来

  • 删除线

要加删除线的文字左右分别用两个~~号包起来

示例:

**这是加粗的文字**
*这是倾斜的文字*`
***这是斜体加粗的文字***
~~这是加删除线的文字~~

效果如下:

这是加粗的文字
这是倾斜的文字
这是斜体加粗的文字
这是加删除线的文字


三、引用

在引用的文字前加>即可。引用也可以嵌套,如加两个>>三个>>>
n个...

示例:

>这是引用的内容
>>这是引用的内容
>>>这是引用的内容

效果如下:

  • 这是引用的内容

这是引用的内容
这是引用的内容
这是引用的内容

四、分割线

三个或者三个以上的 - 或者 * 都可以。

示例:

---
***

效果如下:
可以看到,显示效果是一样的。


五、图片

语法:

![图片alt](图片地址 ''图片title'')

图片alt就是显示在图片下面的文字,相当于对图片内容的解释。
图片title是图片的标题,当鼠标移到图片上时显示的内容。title可加可不加

**上传本地图片直接拖进去

六、超链接

语法:

[超链接名](超链接地址 "超链接title")
title可加可不加

示例:

[百度](http://baidu.com)

效果如下:

百度


七、列表

  • 无序列表

语法:
无序列表用 - + * 任何一种都可以

- 列表内容
+ 列表内容
* 列表内容

注意:- + * 跟内容之间都要有一个空格

效果如下:

  • 列表内容

  • 列表内容

  • 列表内容

  • 有序列表

语法:
数字加点

1.列表内容
2.列表内容
3.列表内容

注意:序号跟内容之间要有空格

效果如下:

1.列表内容
2.列表内容
3.列表内容

  • 列表嵌套

上一级和下一级之间敲三个空格即可

  • 一级无序列表内容

    • 二级无序列表内容
    • 二级无序列表内容
    • 二级无序列表内容
  • 一级无序列表内容

    1. 二级有序列表内容
    2. 二级有序列表内容
    3. 二级有序列表内容
  1. 一级有序列表内容

    • 二级无序列表内容
    • 二级无序列表内容
    • 二级无序列表内容
  2. 一级有序列表内容

    1. 二级有序列表内容
    2. 二级有序列表内容
    3. 二级有序列表内容

八、表格

语法:

表头|表头|表头
---|:--:|---:
内容|内容|内容
内容|内容|内容

第二行分割表头和内容。
- 有一个就行,为了对齐,多加了几个
文字默认居左
-两边加:表示文字居中
-右边加:表示文字居右
注:原生的语法两边都要用 | 包起来。此处省略

示例:

| 表头 | 表头 | 表头 |
| --- | --- | --- |
|第一行|第一行|第一行|
|第二行|第二行|第二行|
|第三行|第三行|第三行|

效果如下:

表头表头表头
第一行 第一行 第一行
第二行 第二行 第二行
第三行 第三行 第三行

九、代码

语法:
单行代码:代码之间分别用一个反引号包起来

    `代码内容`

代码块:代码之间分别用三个反引号包起来,且两边的反引号单独占一行

    ```
      代码内容
    ```

以上就是常用的格式,很简单,大家试着写一写;很快就能上手。

参考文献
https://www.jianshu.com/p/f378e3f2e7e1

posted @ 2019-06-03 15:29  一般网友  阅读(15104)  评论(0编辑  收藏  举报