Common Markdown 简明教程 9053 | 特厉害计划
  • Why Github?
  • Team
  • Enterprise
  • Explore
  • Marketplace
  • Pricing
Sign inSign up
Watch996
Star102.4k
Fork61.8k
Branch: beex.help
Switch branches/tags
Branches
Tags
  •  
K / Common Markdown 简明教程.md
224 lines 8.17 KB
First commit on 24 Jun 2020

    本文为不懂 Markdown 的用户简单介绍一下 Markdown 的语法。Markdown 有很多种方言(写法),本文使用 CommonMark(0.29 版)方言。另外由于表格和待办事项很常用,所以 Beex 也支持表格和待办列表(至少目前不属于 CommonMark 规范)的语法。

    完整版规范在这里:CommonMark 0.29。不过它太长了,你看我写的就行了。

    记事本就可以编辑 .md 文件,当然你可以下载 VS Code 作为 Markdown 编辑器,会有语法高亮,比较好看。

    直接上例子,如果你正在用电脑浏览,左侧是源文件的写法,右侧是输出效果。如果你正在用手机,上方是源码,下方是效果。

    标题

    # 一级标题
    ## 二级标题
    ### 三级标题
    

    你可以看到本文各章节的标题,在例子中输出标题也会打乱序号,所以不演示了。注意 # 后面跟一个空格。

    段落和换行

    一个普通段落。(与其他部分上下有一个空行。)
    
    一个
    软换行。(相邻两行渲染后是不换行的,
    此处的换行符会被显示为一个空格。)
    
    一个  
    硬换行。(在每一行末尾加两个空格,  
    就会被硬换行。)
    

    一个普通段落。(与其他部分上下有一个空行。)

    一个 软换行。(相邻两行渲染后是不换行的, 此处的换行符会被显示为一个空格。)

    一个
    硬换行。(在每一行末尾加两个空格,
    就会被硬换行。)

    列表

    - 无序列表项
    - 无序列表项
    
    1. 有序列表项
    2. 有序列表项
    
    - 无序列表项
        - 子列表项
    
    • 无序列表项
    • 无序列表项
    1. 有序列表项
    2. 有序列表项
    • 无序列表项
      • 子列表项

    行内样式

    - 一个星号:*斜体*
    - 两个星号:**加粗**
    - 反引号:`行内代码`,当你需要原样输出
    Markdown 的标记字符时,就需要用它。
    比如你想输出星号而不是`*斜体*`。
    
    • 一个星号:斜体
    • 两个星号:加粗
    • 反引号:行内代码,当你需要原样输出 Markdown 的标记字符时,就需要用它。 比如你想输出星号而不是*斜体*

    链接和图片

    - 超链接的形式如 `[]()`,紧挨一起,
    `[]` 内是标题,`()` 内是链接地址,
    比如[特厉害](http://www.telihai.com/)。
    
    - 图片就是在链接前加英文叹号 `![]()`,只在
    `()` 内填图片地址就可以了。对于本地图片,
    如果与文章在同一个目录里,可以直接填图片名字。
    
    • 超链接的形式如 [](),紧挨一起, [] 内是标题,() 内是链接地址, 比如特厉害

    • 图片就是在链接前加英文叹号 ![](),只在 () 内填图片地址就可以了。对于本地图片, 如果与文章在同一个目录里,可以直接填图片名字。

    引用(缩进)

    > 一个大于号开头,表示这是一段引用。
    >> 无空行,二级缩进。
    
    > 有空行引用,这相当于一个新的段落。
    

    一个大于号开头,表示这是一段引用。

    无空行,二级缩进。

    有空行引用,这相当于一个新的段落。

    原始代码块

    如果需要输出一大段代码块,或者原始字符块
    (不希望被排版引擎渲染),用三个反引号:
    
    ```
    # 你在这里输入的内容都不会被转义渲染。
    
    - 不会变成列表,原样输出。
    ```
    

    如果需要输出一大段代码块,或者原始字符块 (不希望被排版引擎渲染),用三个反引号:

    # 你在这里输入的内容都不会被转义渲染。
    
    - 不会变成列表,原样输出。
    

    待办列表

    • 注意

      不能排除未来 CommonMark 规范化的待办语法与 Beex 现用的冲突,所以待办语法在未来可能是不稳定的。

    - [ ] 未完成
    - [x] 已完成
    - [] 未完成 `[]` 中间必须有空格,
    否则只是普通列表
    
    [ ] 只能与列表组合使用。
    
    • 未完成
    • 已完成
    • [] 未完成 [] 中间必须有空格, 否则只是普通列表

    [ ] 只能与列表组合使用。

    表格

    • 注意

      不能排除未来 CommonMark 规范化的表格语法与 Beex 现用的冲突,所以表格语法在未来可能是不稳定的。

    |标题 1|标题 2|标题 3|
    |-|-|-|
    |内容 1|内容 2|内容 3|
    |行 2 1|行 2 2|行 2 3|
    
    标题 1标题 2标题 3
    内容 1内容 2内容 3
    行 2 1行 2 2行 2 3

    常用的就是这些,更精细的排版可以用 HTML 标签混合写作,样式定制使用 CSS,不过不在本文范围内。