常用markdown语法

最新推荐文章于 2025-08-23 07:12:40 发布

weixin_30687811

最新推荐文章于 2025-08-23 07:12:40 发布

阅读量72

点赞数

CC 4.0 BY-SA版权

文章标签： markdown javascript ViewUI

原文链接：http://www.cnblogs.com/winner-0715/p/10262533.html

我们在github或gitlab上托管的项目通常需要一个README.md说明文件，md是markdown的缩写，下面简单学习一下markdown的语法,这里只列一下常用的语法，后面有用到再补充吧

代码

要标记一小段行内代码，用反引号(``)包起来

如调用方法：`void method(String param)`，

对应的效果

另外还可以设置代码高亮，根据代码类型来选择，输入格式为：

```java (type)
    code here
```

如

``` javascript
function test() {
    console.log("Hello world!");
}
```

对应的效果为

标题

用#的数量表示1-6阶的标题，#和标题文字之间要有一个空格！

如：

# 标题H1

## 标题H2

### 标题H3

#### 标题H4

##### 标题H5

###### 标题H5

效果为：

链接

链接文字都是用 [方括号] 来标记，在方块括号后面紧接着圆括号并插入网址链接即可(方括号和圆括号之间不要有空格)，如果你还想要加上链接的 title 文字，只要在网址后面，用双引号把 title 文字包起来即可，如：

[普通链接](https://www.mdeditor.com/)
[普通链接带标题](https://www.mdeditor.com/ "普通链接带标题")(hover时显示的名称)
直接链接：<https://www.mdeditor.com>

[锚点链接][anchor-id]
[anchor-id]: https://www.mdeditor.com/

[mailto:test.test@gmail.com](mailto:test.test@gmail.com)
GFM a-tail link @pandao
邮箱地址自动链接 test.test@gmail.com  www@vip.qq.com
> @pandao

对应的效果为：

列表

如：

#### 无序列表（星号）Unordered Lists (*)

* 列表一
* 列表二
* 列表三

#### 无序列表（加号和嵌套）Unordered Lists (+)
+ 列表一
+ 列表二
    + 列表二-1
    + 列表二-2
    + 列表二-3
+ 列表三
    * 列表一
    * 列表二
    * 列表三

#### 有序列表 Ordered Lists (-)

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

对应的效果为：

字符效果和横线等

----

表示一条横线，效果

**粗体**  __粗体__

*斜体字*      _斜体字_

***粗斜体*** ___粗斜体___

引用

### 引用 Blockquotes

> 引用文本 Blockquotes

效果：

图片

! + [替代图片的文字，可空,但是中括号不能为空] + (路径 title)

![](https://www.mdeditor.com/images/logos/markdown.png "markdown")

删除

文本两端加上两个~~即可或<s>标签

~~删除我~~(有时不管用)

<s>删除我<s>(my favourite)

Ref:

https://www.mdeditor.com/

http://www.cnblogs.com/rossoneri/p/4446440.html

http://mahua.jser.me/

转载于:https://www.cnblogs.com/winner-0715/p/10262533.html