最近写GitHub上的README.md文件,要用到Markdown语法,所以本文总结一下用于写 .md.markdown 结尾的文档的基本语法。

网上有不少在线的Markdown编辑器,本人一般用GitHub直接编写然后在线预览,或者用UltraEdit编辑器实时预览。

目录

标题 {#标题}

可以用=标记一级标题、- 标记二级标题,或者用# 标记各级标题(符号后有空格)。

一级标题
=================
二级标题
-----------------

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

格式 {#格式}

换行 {#换行}

两个以上空格加上回车,或者在段落后面使用一个空行来表示重新开始一个段落。 具体可以看下下面的演示图。

字体 {#字体}

*斜体文本*
_斜体文本_

**粗体文本**
__粗体文本__

***粗斜体文本***
___粗斜体文本___
Markdown 字体
Markdown 字体

分隔线 {#分割线}

在一行中用三个以上的星号、减号、底线来建立一个分隔线

***
* * *
*****

- - -
----------

_ _ _
___

删除线 {#删除线}

在文字的两端加上两个波浪线 ~~ 即可,部分编辑器单个波浪线也可。

~删除线~
~~删除线~~

下划线 {#下划线}

<u>下划线</u>

列表 {#列表}

无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,有序列表使用数字并加上 . 号来表示。注意符号后有空格,可嵌套使用。

* 第一项
* 第二项
+ 第一项
+ 第二项
- 第一项
- 第二项

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

嵌套
1. 第一层
	- 第二层
		* 第三层
2. 第一层
	+ 第二层
		1. 第三层
Markdown 列表
Markdown 列表

区块(引用) {#引用}

区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格。注意换行使用两空格和直接空行的区别。区块也可以嵌套使用,也可以和列表混合嵌套。

> 区块引用
> 第一行后没用两空格的内容  
> 第二行用了两空格用于换行
> 
> 上一行行空行效果

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

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> 	> 引用  
>   > 内容
> + 第二项
Markdown 区块引用
Markdown 区块引用

代码 {#代码}

段落上的一个函数或片段的代码可以用反引号把它包起来(`)。代码区块使用 4 个空格或者一个制表符(Tab 键),或者用 ``` 包裹一段代码,并指定一种语言(也可以不指定)。

`printf()` 函数

## 代码区块

    function a() {
       retrun 0;
    }

```javascript
$(document).ready(function () {
    alert('Hi!');
});
```
Markdown 代码
Markdown 代码

链接 {#链接}

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

<链接地址>
<https://www.tidnotes.ga>

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

[1]: https://www.google.com/
[tidnotes]: https://www.tidnotes.com/
Markdown 链接
Markdown 链接

图片 {#图片}

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

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

Markdown不能定义图片大小,可以用<img>标签来插入图片。

表格 {#表格}

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

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

| 对齐方式:左对齐 | 对齐方式:右对齐 | 对齐方式:居中对齐 |
| :----- | -----: | :------: |
| 单元格 | 单元格 | 单元格   |
| 单元格 | 单元格 | 单元格   |
Markdown 表格
Markdown 表格

兼容 {#兼容}

Markdown是支持HTML的,想要更好的显示效果可以使用HTML的写法来编辑文本。

本文由 小TiD笔记 发布在小TiD笔记,转载此文请保持文章完整性,并请附上文章来源(小TiD笔记)及本页链接。

原文链接: https://www.tidnotes.ga/2020/03/markdown-edit.html