Markdown 编辑教程

Markdown 语法规则与最佳实践

什么是 Markdown

Markdown 是一种轻量化的标记语言,允许人们使用易读易写的纯文本格式编写文档。Markdown 文件的后缀通常是 .md 或 .markdown。GitHub、Reddit 等平台都支持 Markdown 进行文档编写和讨论。

基本语法

  • 标题

    使用 # 号开头,一到六个 # 分别表示一级到六级标题

    # 一级标题
    ## 二级标题
    ### 三级标题
    #### 四级标题
    ##### 五级标题
    ###### 六级标题
  • 粗体

    使用 **粗体** 或 __粗体__

    **这是粗体文本**
    __这也是粗体文本__
  • 斜体

    使用 *斜体* 或 _斜体_

    *这是斜体文本*
    _这也是斜体文本_
  • 删除线

    使用 ~~删除线~~

    ~~这段文字有删除线~~
  • 图片

    使用 ![替代文本](图片URL)

    ![Logo](https://www.format.cool/logo.png)
    ![风景图片](https://www.format.cool/logo.png)
  • 代码块

    使用 ```代码块``` 或 `行内代码`

    这是一个 `行内代码` 示例
    
    ```
    这是多行代码块
    可以写多行代码
    ```
  • 无序列表

    使用 -、* 或 + 开头

    - 苹果
    - 香蕉
    - 橙子
    
    * 或者用星号
    * 第二项
    
    + 或者用加号
    + 第二项
  • 有序列表

    使用数字加点,如 1. 2. 3.

    1. 第一步
    2. 第二步
    3. 第三步
  • 嵌套列表

    在子列表前添加两个空格或四个空格

    - 水果
      - 苹果
        - 红富士
      - 香蕉
    - 蔬菜
      - 白菜
      - 萝卜
  • 任务列表

    使用 - [ ] 表示未完成,- [x] 表示已完成

    - [ ] 待办事项一
    - [ ] 待办事项二
    - [x] 已完成事项
    - [ ] 第三个待办
  • 基本表格

    使用 | 分隔列,使用 --- 分隔表头和内容

    | 列1 | 列2 | 列3 |
    | --- | --- | --- |
    | 内容1 | 内容2 | 内容3 |
    | 内容4 | 内容5 | 内容6 |
  • 对齐表格

    可以在 --- 两侧添加冒号指定对齐方式,如 |:---|:---:|---:|

    | 左对齐 | 居中对齐 | 右对齐 |
    | :--- | :---: | ---: |
    | 文本 | 文本 | 文本 |
    | 较长文本 | 较长文本 | 较长文本 |
  • 引用

    使用 > 开头,可嵌套使用 >>

    > 这是一级引用
    >> 这是二级嵌套引用
    >>> 这是三级嵌套引用
  • 分割线

    使用 ---、*** 或 ___

    上面内容
    
    ---
    
    中间分割线
    
    ***
    
    再分一次
    
    ___
  • 转义

    使用 \ 转义特殊字符,如 \* 不显示为粗体

    \* 这不会变成粗体 \*
    \[ 这不会变成链接 \]
    \! 这不会变成图片
  • 代码高亮

    使用 ```语言 指定编程语言以获得语法高亮

    ```javascript
    function hello() {
        console.log("Hello World!");
    }
    ```
    
    ```python
    def hello():
        print("Hello World!")
    ```
    
    ```html
    <div>HTML代码</div>
    ```
  • GFM删除线

    GFM 支持 ~~删除线~~ 语法

    GFM 支持 ~~删除线效果~~ 这种写法
  • 任务列表

    支持 - [ ] 和 - [x] 任务列表

    - [x] 完成任务
    - [ ] 待办
    - [ ] 另一个待办
  • GFM表格

    GFM 支持完整的表格语法

    | 功能 | 支持 |
    | --- | --- |
    | 表格 | ✅ |
    | 任务列表 | ✅ |
    | 代码块 | ✅ |
  • 围栏代码块

    支持 ``` 开头和结尾的代码块

    ```
    这段是代码块
    不需要指定语言
    ```

使用工具

使用 format.cool 的 Markdown 编辑器,你可以:

  • 实时预览:左边编写,右边即时查看效果
  • 支持 GFM:完整支持 GitHub flavored Markdown
  • 代码高亮:多种编程语言语法高亮
  • 一键复制:快速复制生成的 HTML 或 Markdown