Markdowm

01 基础语法

标题

  • Markdown 中标题如果想定义一个标题，可以在前面加上 #(或者用#将标题括起来)。
  • 1-6 个#分别表示 1-6 级标题。

  • 有的编辑器需要在# 和正文之间加一个空格 (Atom/语雀)，有的编译器不用 (MarkdownPad)，为了保持同一建议都加上空格。

    1. # 标题一
    2. #标题一#
    3. ## 标题二

    文本样式

  • Markdown 支持 4 中文本样式，分别是：加粗、斜体、删除线和加粗且斜体。

  • 语雀
    • 加粗:
    • 斜体：
    • 删除线没问题
    • 加粗且斜体不行 | 样式 | 关键字 | 快捷键 | 样例 | 输出 | | :—- | :—- | :—- | :—- | :—- | | 加粗 | ** **或者__ __ | command/control+b | **加粗文本** | 加粗文本 | | 斜体 | * *或者_ _ | command/control+i | _斜体文本_ | 斜体文本 | | 删除线 | ~~ ~~ | 无 | ~~删除线~~ | 删除线 | | 加粗且斜体 | ** **和_ _ | 无 | **这个是：_加粗且斜体_** | 这个是加粗且斜体 |

引用文本

  • 引用文本的关键字是 >，后面加空格
    1. 下面是一个引用：
    2. > 大家好！我是一个引用。
    输出结果：
    下面是一个引用：

    大家好！我是一个引用

引用代码

  • 引用代码有两种形式
    • 一种是在文本中引入一个代码：使用一个倒引号 ` 括起来；
    • 另一种是插入一段代码：使用三个倒引号 ``` 括起来 (非标准 Markdown 语法, Atom 中支持 MarkdownPad 中不支持)。
      • 语雀插入代码，三个倒引号```和回车键就可以了 
        1. 我需要在文中插入快捷键`ctrl+v`.
        结果：
        我需要在文中插入快捷键ctrl+v.
  1. 我需要引用一段代码：  
  2. ```c++
  3. int a = 1;
  4. int b = 2;
  5. int c = a+b;
  1. 结果：<br />我需要引用一段代码：
  2. ```c
  3. int a = 1;
  4. int b = 2;
  5. int c = a+b;

链接

  • Git 编译器关于链接的使用加入了较多的扩展。这里仅介绍标准 Markdown 语法中的行内链接和参考链接。
    下面是行内链接示例：
    1. [链接到百度](https://www.baidu.com)
    结果：
    链接到百度

下面是一个参考链接的示例：(这种语雀不支持）

  1. [链接到百度][1]
  2. [链接到Google][2]  
  3. [还是链接到百度][1]
  4. [1]:https://www.baidu.com  
  5. [2]:https://www.google.com

结果：
链接到百度
链接到 Google
还是链接到百度
参考链接中的标号 1,2 不仅仅可以是数字，也可以是字母或它们的组合。
同时链接也支持相对路径，./ 表示当前目录，../ 表示前一级目录。这里也建议在编写文档时，不同文档之间的关联采用相对路径的形式。

列表

  • 我们可以使用 *,+,- 或者数字作为列表的关键字。同时列表也支持嵌套的形式
  • tab和shift+tab进行主次调整 ```
  • 主列表1
  • 主列表2
    1. 次列表1
    2. 次列表2
  • 主列表3 ``` 结果：
  • 主列表 1
  • 主列表 2
    • 次列表 1
    • 次列表 2
  • 主列表 3

任务列表

  • 任务列表是 Git 对标准 Markdown 语法的扩展，并不是标准 Markdown 语法。因此 MarkdownPad 不会对该语法进行渲染。但是使用 Atom 就会对该语法进行渲染。
    • 语雀只需要[]和[x] ```
  • 任务列表1
  • 任务列表2

  • [ ] 任务列表3 ``` 结果：

  • [x] 任务列表 1

  • 任务列表 2

  • [ ] 任务列表 3

    忽略 Markdown 关键字

  • 和 C 语言 printf 函数一样，如果我们不想让某个字符转换成 Markdown 关键字，可以在前面加上 . 比如我们想输入两个 *, 就可以用：

    • 好像在语雀不咋使用
      1. \*\*取消Markdown关键字
      输出结果:

      ** 取消 Markdown 关键字

唤起卡片输入

  • 直接通过在编辑器首行中输入“ / ” 快速唤起卡片插入，选择代码块进行插入。

【参考链接】

02 进阶语法

Flowchart（流程图）

入门案例

语法

  • 流程图的语法大体分为两部分

    • 01 | 定义流程图元素

      • 1.1 语法格式：tag=>type: content:>url
        • 语法说明
          • tag 是流程图中的标签，在第二段连接元素时会用到。名称可以任意，一般为流程的英文缩写和数字的组合。
          • type 用来确定标签的类型，=>后面表示类型。由于标签的名称可以任意指定，所以要依赖type来确定标签的类型
            • 标签有6种类型：start end operation subroutine condition inputoutput
          • content 是流程图文本框中的描述内容，: 后面表示内容，中英文均可。特别注意，冒号与文本之间一定要有个空格
          • url是一个连接，与框框中的文本相绑定，:>后面就是对应的 url 链接，点击文本时可以通过链接跳转到 url 指定页面

      • 1.2 流程图元素

        • start 开始

        • operation 操作、执行说明

        • condition 条件

        • inputoutput

        • subroutine

        • end 结束

    • 02 | 连接流程图元素，指定流程图的执行走向

      • 2.1 语法格式：st->op1->cond
        • 语法说明
          • 使用 -> 来连接两个元素
          • 对于condition类型，有yes和no两个分支，如示例中的cond(yes)和cond(no)
          • 每个元素可以制定分支走向，默认向下，也可以用right指向右边，如示例中sub1(right)。

            参考链接

  • https://segmentfault.com/a/1190000006247465

  • https://blog.csdn.net/ethmery/article/details/50670294
  • https://github.com/adrai/flowchart.js
  • https://bramp.github.io/js-sequence-diagrams/

设置目录