Markdown语法教程

BlackImp / 2023-05-14 / 原文

Markdown语法教程

目录
  • Markdown应用
  • 一、标题语法
    • 1.1 字体
    • 1.2 分割线
    • 1.3 删除线
    • 1.4 下划线
    • 1.5 脚注
    • 1.6 Markdown列表
      • 1.6.1 Markdown 支持有序列表和无序列表
        • 1.6.1.1 无序列表
        • 1.6.1.2 有序列表
      • 1.6.2 列表嵌套
    • 1.7 Markdown 区块
      • 1.7.1 引用
      • 1.7.2 区块中使用列表
    • 1.8 Markdown 代码
      • 1.8.1 代码区块
    • 1.9 Markdown 链接
      • 1.9.1 高级链接
    • 1.10 Markdown 图片
    • 1.11 Markdown 表格

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。

Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。

Markdown应用

​ 当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。

一、标题语法

使用格式: # 空格 标题

​ 使用#号可以标记1到6级标题一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。

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

1.1 字体

使用格式:

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

示例:

​ 正常文字

斜体文字

斜体文字

粗体文字

​ *粗体文字加斜体文字*

1.2 分割线

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

***

* * *

*****

- - -

----------

分割线1


分割线2


1.3 删除线

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

RUNOOB.COM
GOOGLE.COM
~~BAIDU.COM~~

这是要删除的文字

​ 士大夫

1.4 下划线

​ 下划线可以通过 HTML 的 标签来实现:

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

下划线字体

下划线

1.5 脚注

​ 脚注是对文本的补充说明。

​ Markdown 脚注的格式如下:

[^要注明的文本]

​ 创建脚注^test

1.6 Markdown列表

1.6.1 Markdown 支持有序列表和无序列表

1.6.1.1 无序列表

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

* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项

- 第一项
- 第二项
- 第三项
  • 第一项
    • 子项1
      • 子项2
        • 子项3
          • 子项4
  • 第二项
  • 第三项
1.6.1.2 有序列表

​ 使用数字和一个英文句点表示有序列表。
​ 注意:英文句点后面一定要有一个空格,起到缩进的作用。:

1. 第一项
2. 第二项
3. 第三项
  1. test1
  2. test2
  3. test3

1.6.2 列表嵌套

  1. 第一项
    • test1
    • test2
  2. 第二项
    • test1
    • 托尔斯泰

1.7 Markdown 区块

1.7.1 引用

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

区块引用

菜鸟教程

学的是菜鸟的技术

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

引用第一层

引用第二层

引用第三层

1.7.2 区块中使用列表

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

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

区块中使用列表

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

1.8 Markdown 代码

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

`printf()` 函数

​ 显示结果如下:

printf()函数

1.8.1 代码区块

代码区块使用 4 个空格或者一个制表符(Tab 键)

实例如下:

class Test {

public static void main(String[] args){

System.out.println(“hello world!!!”);

}

}

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

Class Test
{
	public static void main(String[] args)
    {        
        System.out.println();
    }
}

1.9 Markdown 链接

​ 链接使用方法如下:

[链接名称](链接地址)

或者

<链接地址>

例如:这是一个连接菜鸟教程

直接使用链接地址:

https://www.runoob.com

1.9.1 高级链接

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

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

显示结果如下:

这个链接用 1 作为网址变量Google

1.10 Markdown 图片

​ Markdown 图片语法格式如下:

![alt 属性文本](图片地址)

![alt 属性文本](图片地址 "可选标题")
  • 开头一个感叹号 !
  • 接着一个方括号,里面放上图片的替代文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。

1.11 Markdown 表格

​ Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。

​ 语法格式如下:

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

​ 对齐方式

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

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

实例如下:

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