Markdown 小结

Markdown 是一种轻量级标记语言,它允许人们使用易读、易写的纯文本格式编写文档。Markdown 语言需要经过编辑器的渲染才能呈现出各种优美的格式。

Markdown 的使用场景:

当你对文章的排版没什么特殊需求,且不想花太多时间在排版上时,就可以使用 Markdown。因为编辑器或平台会通过 Markdown 标记对文章进行渲染,最终的排版效果会非常简洁、漂亮。

Markdown 标题:

标题推荐语法:

# + 空格 + 标题内容

语法说明如下:

  • 在行首插入 # 可标记出标题。
  • # 的个数表示了标题的等级。
  • 建议在 # 后加一个空格。
  • Markdown 中最多只支持前六级标题,类似于 HTML 中的 h1~h6。

标题规范如下:

1) 建议使用#标记标题,而不是 === 或 ---
2) 要保持间距,建议标题的前后都要空 1 行(除非标题在文档开头);# 与标题文本之间也要有1个空格
3) 不要有多余的空格。建议标题要写在一行的开头,结尾也不要有空格。
4) 建议标题的结尾不要有标点符号,如句号、逗号、冒号、分号等。
5) 建议标题要尽量简短,这样方便引用,特别是当生成目录时。如果原拟的标题是一个长句,可以从长句中提取标题,而将长句作为标题下的内容。
使用 Markdown 写文档比较推荐的结构如下:
# 文档标题

作者

摘要

目录

## 标题1

### 标题 1.1

## 标题2

### 标题2.1

### 标题2.2

说明如下:

  • 文档标题:文档的第一个标题应该是一级标题,写在第一行,建议与文件名相同,标题要尽量简短。
  • 作者:可选,用于声明文档的作者,如果是开源项目的文档,建议把作者名写在修订历史中。
  • 摘要:用 1~3 句话描述文档的核心内容。
  • 目录:用于快速了解文档的结构,便于导航。
  • 正文:正文中的标题从二级目录开始,逐级增加,不可跳级,不可相同。

Markdown 加粗和斜体:

在 Markdown 中,加粗(粗体)由两个 或两个 包裹,斜体由一个 或一个 包裹。

示例:

**加粗**
__加粗__

*斜体*
_斜体_

加粗 和 斜体 的使用规范:

1) 建议粗体使用两个*包裹,斜体使用一个*包裹,因为*比较常见,而且比_可读性更强。
2) 在粗体和斜体语法标记的内部,建议不要有空格。

Markdown 的段落和换行:

Markdown 中的段落由一行或多行文本组成,不同的段落之间使用 空行 来标记。

语法说明如下:

  • 如果行与行之间没有空行,则会被视为同一段落。
  • 如果行与行之间有空行,则会被视为不同的段落。
  • 空行是指行内什么都没有,或者只有空格和制表符。
  • 如果想在段内换行,则需要在上一行的结尾插入两个以上的空格然后按回车键。

示例如下:

段落和换行的规范:

为了便于阅读,应该限制每行字符的数量,通常每行不超过 80 个字符,可以在编辑器中进行设置。

关于换行,建议如下:

  • 当超过80个字符后进行换行。
  • 在一句话结束(句号、叹号或问号)之后换行。
  • 当 URL 较长时换行。

通常 URL 较长会导致行字符数量超过限制,为了提高可读性,可以在 URL 之前加一个换行符(\n),如下:

大家好,给大家推荐一套不错的 Python 教程:
[Python基础教程,Python入门教程(非常详细)](http://c.biancheng.net/python/)

或者通过引用链接来进行优化:

大家好,给大家推荐一套不错的 Python 教程:[Python基础教程,Python入门教程(非常详细)]

[Python基础教程,Python入门教程(非常详细)]: http://c.biancheng.net/python/

Markdown列表:

Markdown 支持使用有序列表和无序列表,类似于 HTML 中的 <ul> 和 <ol> 标签。

有序列表的语法如下:

数字序号 + 英文句号 + 空格 + 列表内容

无序列表的语法如下:

*/+/-  +  空格  +  列表内容

使用*、+、-来标记无序列表的效果是相同的。

列表的嵌套:

嵌套列表的语法:

+ 第一层列表
TAB + 第二层列表
TAB + TAB + 第三层列表

语法说明如下。

  • 列表中可以嵌套列表。
  • 有序列表和无序列表也可以互相嵌套。

列表使用规范:

1) 建议使用 - 来标记无序列表,因为*容易跟粗体和斜体混淆,而+不流行。
2) 如果一个列表中所有的列表项都没有换行,建议使用 1 个空格。 (列表项内容和列表标识之间)
3) 如果列表项有换行,则建议给无序列表使用 3 个空格,给有序列表使用 2 个空格。(列表项内容和列表标识之间)
4) 如果一个列表中的每个列表项都只有 1 行,建议列表项之间不要有空行。
5) 如果列表项中有换行,建议在列表项之间空 1 行,这样会比较容易区分多行列表项的开始和结束。
6) 建议在列表前/后都空 1 行。

示例如下:

# 列表

## 有序列表

1. C语言中文网
2. Markdown教程
3. http://c.biancheng.net/markdown/

## 无序列表

- 使用【减号】标识无序列表
- 使用【减号】标识无序列表

## 嵌套列表

- 我是第一层列表
    - 我是第二层列表
        - 我是第三层列表
            - 我是第四层列表

## 有序列表和无序列表相互嵌套

1. 我是第一层列表
    - 我是第二层列表
        1. 我是第三层列表一
        2. 我是第三层列表二

- C语言入门教程
- http://c.biancheng.net/c/

-   C语言入门教程
-   http://c.biancheng.net/c/

-   这个列表
    有换行
-   这个没有换行

1.  这个有序列表
    有换行
2.  这个没有换行

- Markdown教程:http://c.biancheng.net/markdown/
- Python教程:http://c.biancheng.net/python/
- Java教程:http://c.biancheng.net/java/

-   Markdown教程:
    http://c.biancheng.net/markdown/

-   Python教程:
    http://c.biancheng.net/python/

-   Java教程:
    http://c.biancheng.net/java/

markdown 下划线:

在 Markdown 中,分隔线由 3 个以上的*或者_来标记。_是下划线,而不是减号。

语法如下:

第一行内容
***
第二行内容
___
第三行内容

语法说明:

  • 分隔线须使用至少 3 个以上的*或者_来标记。
  • 标识符行内不能有其他的字符。
  • 可以在标记符中间加上空格。

示例如下:

## 星号作为分割线

第一行内容
***
第二行内容  
哈哈
* * * 
第三行内容
********

## 下划线作为分割线

第一行内容
___
第二行内容
_ _ _
第三行内容
_______

aaa

猜你喜欢

转载自www.cnblogs.com/neozheng/p/12110154.html