Markdown使用指南


参考链接:https://www.runoob.com/markdown/md-tutorial.html

1.Why Markdown

  • Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
  • Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
  • 当前许多网站都广泛使用 Markdown来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。

2.测试实例

Markdown编写Hello World!语法:

# Hello World!

显示效果如下:

Hello World!


3.Markdown标题

Markdown标题有两种格式:

使用=和-标记一级和二级标题

=和-标记语法格式如下:

我展示的是一级标题
====
我展示的是二级标题
----

显示效果如下:

我展示的是一级标题

我展示的是二级标题

使用#号标记

使用#号可以表示1-6级标题,一级标题对应一个#号,二级标题对应两个#号,依此类推

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

显示效果如下:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

4.Markdown段落

Markdown段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车

字体

*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗体文本___

斜体文本

斜体文本

粗体文本

粗体文本

粗斜体文本

粗斜体文本

分割线

你可以在一行中用三个以上的星号、减号、底线来建立一个分割线,行内不能有其他东西。你也可以在星号或者是减号中间插入空格。下面每种写法都可以建立分隔线

***

* * *

*****

- - -

-----

显示效果如下:






删除线

如果段落上的文字要添加删除线,只需要在文字的两端加上两个~~即可,实例如下:

GOOGLE.COM
~~BAIDU.COM~~

显示效果如下:
GOOGLE.COM
BAIDU.COM

下划线

下划线可以通过HTML的<u>标签来实现:

<u>带下划线的文本</u>

显示效果如下:
带下划线的文本

脚注

脚注是对文本的补充说明。
Markdown脚注的格式如下:

[^要注明的文本]

以下实列演示了脚注的用法:

创建脚注的格式类似这样 [^RUNOOB]。
[^RUNOOB]:菜鸟教程--学的不仅是技术,更是梦想!

演示效果如下:
创建脚注的格式类似这样:[^RUNOOB]。
[^RUNOOB]:此处为脚注演示


5.Markdown列表

Markdown支持有序列表和无序列表
无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:


* 第一项
* 第二项

+ 第一项
+ 第二项

- 第一项
- 第二项

显示效果如下:

  • 第一项
  • 第二项
  • 第一项
  • 第二项
  • 第一项
  • 第二项

有序列表使用数字加上.号来表示,如:

1.第一项
2.第二项
3.第三项

显示效果如下:
1.第一项
2.第二项
3.第三项

列表嵌套

列表嵌套只需在子列表中的选项前面添加四个空格即可:

1.第一项:
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2.第二项:
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

显示效果如下:
1.第一项:

  • 第一项嵌套的第一个元素
  • 第一项嵌套的第二个元素

2.第二项:

  • 第二项嵌套的第一个元素
  • 第二项嵌套的第二个元素

6.Markdown区块

Markdown区块引用是在段落的开头使用>符号,然后后面紧跟着一个空格符号:

>区块引用
>菜鸟教程
>学的不是技术更是梦想

显示结果如下:

区块引用
菜鸟教程
学的不是技术更是梦想

另外区块也是可以嵌套的,一个>符号是最外层,两个>符号是第一层的嵌套,以此类推:

>最外层
>>第一层嵌套
>>>第二层嵌套

最外层

第一层嵌套

第二层嵌套

区块中使用列表

区块中使用列表实例如下:

>区块中使用列表
>1.第一项
>2.第二项
>+ 第一项
>+ 第二项
>+ 第三项

显示结果如下:

区块中使用列表
1.第一项
2.第二项

  • 第一项
  • 第二项
  • 第三项

列表中使用区块

如果要在列表项目内放进区块,那么就需要在>前添加四个空格的缩进。
区块中使用列表实例如下:

·第一项
    >菜鸟教程
    >学的不仅是技术更是梦想
·第二项

显示结果如下:

  • 第一项

    菜鸟教程
    学的不仅是技术更是梦想

  • 第二项

7.Markdown代码

如果是段落上的一个函数或片段的代码可以用反引号把它包起来(```),例如:

`print()` 函数

显示结果如下:

print() 函数

代码区块

代码区块
代码区块使用四个空格或者一个**制表符(Tab键)**。
实例如下:

    <?php  
    echo 'RUNOOB';  
    function test(){  
        echo 'test'  
    }  

显示结果如下:

<?php  
echo 'RUNOOB';  
function test(){  
    echo 'test'  
} 

你也可以使用`````包裹一段代码,并指定一种语言(也可以不指定):

```javascript
$(document).ready(function){
    alert('RUNOOB');
})

显示结果如下:

$(document).ready(function){
    alert('RUNOOB');
})

8.Markdown链接

链接使用方法如下:

[链接名称](链接地址)
或者
<链接地址>

例如:

这是一个链接 [菜鸟教程](httpd://runoob.com)

显示结果如下:
这是一个链接 菜鸟教程
直接使用地址链接:

<https://www.runoob.com>

显示结果如下:
https://www.runoob.com

高级链接

我们可以通过变量来设置一个链接,变量赋值在文档末尾进行:

这个链接用 1 作为网址变量 [Google][1]
这个链接用 runoob 作为网址变量 [Runoob][runoob]
然后在文档的结尾为变量赋值(网址)

  [1]: http://www.google.com/
  [runoob]: http://www.runoob.com/

显示结果如下:
这个链接用 1 作为网址变量 [Google][1]
这个链接用 runoob 作为网址变量 [Runoob][runoob]
然后在文档的结尾为变量赋值(网址)
[1]:http://www.google.com/
[runoob]:http://www.runoob.com/

9.Markdown图片

Markdown图片语法格式如下:

![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选标题")

开头一个感叹号,接着一个方括号,里面放上图片的替代文字,接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。
使用实例:

![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png)

![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png "RUNOOB")

显示结果如下:
RUNOOB 图标

RUNOOB 图标

当然你也可以像网址那样对图片网址使用变量:

这个链接用 1 作为网址变量 [RUNOOB][1].
然后在文档的结尾为变量赋值(网址)

[1]: http://static.runoob.com/images/runoob-logo.png

显示结果如下:
这个链接用 1 作为网址变量 [RUNOOB][1].
然后在文档的结尾为变量赋值(网址)
[1]: http://static.runoob.com/images/runoob-logo.png

Markdown还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的标签。

<img src="http://static.runoob.com/images/runoob-logo.png" width="50%">

10.Markdown表格

Markdown制作表格使用|来分割不同的单元格,使用-来分割表头和其他行。
语法格式如下:

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

以上代码显示结果如下:

表头 表头
单元格 单元格
单元格 单元格

对其方式
我们可以设置表格的对齐方式:

  • -:设置内容和标题栏居右对齐
  • :-设置内容和标题栏居左对齐
  • :-:实质内容和标题栏居中对齐

实例如下:

| 左对齐 | 右对齐 | 居中对齐 |
| :-| -: | :-: |
| 单元格111 | 单元格111 | 单元格111 |
| 单元格 | 单元格 | 单元格 |

以上代码显示结果如下:

左对齐 右对齐 居中对齐
单元格111 单元格111 单元格111
单元格 单元格 单元格

11.Markdown高级技巧

支持的HTML元素

不在Markdown涵盖范围内的标签,都可以直接在文档里面用HTML撰写。
目前支持的 HTML元素有: <kbd> <b> <i> <em> <sup> <br>等, 如:

使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

输出结果为:
使用 Ctrl+Alt+Del 重启电脑

转义

Markdown使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符:

**文本加粗**
\*\*正常显示星号 \*\*

输出结果为:
文本加粗
**正常显示星号 **
Markdown支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号

Author: WTY
Reprint policy: All articles in this blog are used except for special statements CC BY 4.0 reprint polocy. If reproduced, please indicate source WTY !
  TOC