Skip to content

Latest commit

 

History

History
252 lines (164 loc) · 5.69 KB

markdown.md

File metadata and controls

252 lines (164 loc) · 5.69 KB
Raw

目录

区块元素

 Markdown 可以看作由一系列区块元素纵向排列或嵌套而组成，区块由一些特殊元素开启和关闭(也可看作不同的区块间需要不同的连接方式)
 段落是最主要的区块，段落区块的内容即是我们试图表达信息的文字，而其它区块展示出来的一般只是符号与格式

段落

  • 开启区块：

    • 只要不开启下述其他区块，则便属于开启段落区块

  • 区块之中：

    • 多个空白符(包括空格、制表、换行)会压缩为一个空格， 但是连续的2个空格+换行符会渲染为换行符。此外还有转义空白符： <br>换行，&emsp;制表，&nbsp;空格

  • 关闭区块：

    • 空行、标题、分割线、引用、列表、任务、代码、公式、折叠

  • 建议：

    • 缩进使用&emsp;
    • 换行使用2个空格+换行
    • 隔行使用空行
    • 隔多行使用<br>

标题

  • 开启区块：

    • 行首 1~6个 #+空格

  • 区块之中：

    • 可嵌套的区块元素：段落

  • 关闭区块：

    • 换行即可关闭

分割线

  • 开启区块：

    • 行首至少3个 *且无其他非空白字符

  • 区块之中：

    • 不可嵌套任何其他区块

  • 关闭区块：

    • 换行即可关闭

引用

  • 开启区块：

    • 行首N个 >+空行

  • 区块之中：

    • 可嵌套的区块元素：标题、分割线、段落、引用、列表、任务、代码、公式、制表、折叠

    • 连续的引用区块中，若当前引用区块比上一个引用区块的嵌套级别低则被忽略

  • 关闭区块：

    • 空行、标题、分割线、列表、任务、代码、公式、折叠

  • 建议：

    • 使用连续引用区块，格式更直观且不会无意中关闭区块

    • 使用空行关闭引用区块

列表

  • 开启区块：

    • 无序列表：行首*+空格
    • 有序列表：行首数字+.+空格

  • 区块之中：

    • 可嵌套的区块元素：标题、分割线、段落、引用、列表、任务、代码、公式、制表、折叠
    • 列表区块中，行首缩进级别表示当嵌套前区块在几级列表区块中
    • 各之间的空行表示增大列表之间的间隔

  • 关闭区块：标题、分割符、引用、代码、公式、空行+制表、折叠

  • 建议：

    • 空行无法关闭列表区块，一般使用引用+空行
    • 将列表区块中的内容分开看：父列表内容、子列表内容、嵌套子区块

代码

  • 开启区块：

    • 包围式：行首至少3个连续 ` +代码语言(可选)
    • 缩进式：行首至少4个空格

      所有区块标签提及的“行首”，其实是允许在前面有不多于 4 个空格的

  • 区块之中：

    • 不对代码区块中的内容进行格式化，且会对内容进行语法高亮

  • 关闭区块：

    • 包围式：行首至少3个连续 `
    • 缩进式：换行

  • 建议：

    • 行内添加代码使用`code`即可，添加多行代码时才开启代码区块

公式

  • 公式

    • 开启区块：

      • 行首$$

    • 区块之中：

      • 其中可插入$L_AT^EX$语法代码

    • 关闭区块：

      • $$

    • 建议：

      • 行内添加公式使用$L^A_ET$即可，添加多行代码时才开启代码区块
      • github 不支持公式区块，可以使用一些网站的 api 插入图片，或者给浏览器安装插件

任务

与列表区块类似

- [ ] task1 incomplete item with `space`
- [x] task2 complete item with `x`
  • task1 incomplete item with space
  • task2 complete item with x

制表

| header1              |     header2    |       header3 |
|----------------------|:--------------:|--------------:|
| default left justify | center justify | right justify |
header1 header2 header3
default left justify center justify right justify
  • 建议：
    • 制表前后空行

折叠

<details>
    <summary>Title</summary>

    嵌套其他区块，注意空行与缩进
</details>
Title 
嵌套其他区块，注意空行与缩进
  • 建议：
    • 注意空行

段落内元素

强调

渲染结果 源码
italic *italic*
bold **bold**
italic&bold ***italic&bold***
delete ~~delete~~
underline <u>underline</u>
Ctrl <kbd>Ctrl</kbd>
code `code`
$L^{A}T_{E}X$ $L^{A}T_{E}X$

链接

![图片名](URL "可选标题")
[链接名](URL "可选标题")
[链接名](#锚点名 "可选标题")
<span id="锚点名"></span>
<div title="回显的文本">外面的文本</div>

GitHub

SHA references

16c999e8c71134401a78d4d46435517b2271d6ac
mojombo@16c999e8c71134401a78d4d46435517b2271d6ac
mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac

Issue references

#1
mojombo#1
mojombo/github-flavored-markdown#1

@username

:emoji:

+ 新增
- 删除
! 修改