MarkDown高阶语法手册

清疚 2023-09-28 17:16 160阅读 0赞

[原文链接][Link 1]

#### 1. 内容目录 ####

在段落中填写 `[TOC]` 以显示全文内容的目录结构。

#### 文章目录 ####

*   *   *  1. 内容目录
         *  2. 标签分类
         *  3. 删除线
         *  4. 注脚
         *  5. LaTeX 公式
         *  6. 加强的代码块
         *  7. 流程图
         *   *  示例
         *  8. 序列图
         *   *  示例 1
             *  示例 2
         *  9. 甘特图
         *  10. Mermaid 流程图
         *  11. Mermaid 序列图
         *  12. 表格支持
         *  13. 定义型列表
         *  14. Html 标签
         *  15. 内嵌图标
         *  16. 待办事宜 Todo 列表

#### 2. 标签分类 ####

在编辑区任意行的列首位置输入以下代码给文稿标签：

标签： 数学 英语 Markdown

或者

Tags： 数学 英语 Markdown

#### 3. 删除线 ####

使用 ~~ 表示删除线。

这是一段错误的文本。

#### 4. 注脚 ####

使用 `[^keyword]` 表示注脚。

这是一个注脚1的样例。

这是第二个注脚2的样例。

#### 5. LaTeX 公式 ####

“$” 表示行内公式：

质能守恒方程可以用一个很简洁的方程式  E = m c 2 E=mc^2 E=mc2 来表达。

“$$” 表示整行公式：

∑ i = 1 n a i = 0 \\sum\_\{i=1\}^n a\_i=0 i=1∑nai=0

f ( x 1 , x x , … , x n ) = x 1 2 + x 2 2 + ⋯ + x n 2 f(x\_1,x\_x,\\ldots,x\_n) = x\_1^2 + x\_2^2 + \\cdots + x\_n^2 f(x1,xx,…,xn)=x12\+x22\+⋯\+xn2

∑ k = 0 j − 1 γ ^ k j z k \\sum^\{j-1\}\_\{k=0\}\{\\widehat\{\\gamma\}\_\{kj\} z\_k\} k=0∑j−1γkjzk

访问 [MathJax][] 参考更多使用方法。

#### 6. 加强的代码块 ####

支持四十一种编程语言的语法高亮的显示，行号显示。

非代码示例：

$ sudo apt-get install vim-gnome

Python 示例：

@requires_authorization
    def somefunc(param1='', param2=0):
        '''A docstring'''
        if param1 > param2: # interesting
            print 'Greater'
        return (param2 - param1 + 1) or None
    
    class SomeClass:
        pass
    
    >>> message = '''interpreter
    ... prompt'''

JavaScript 示例：

/**
    * nth element in the fibonacci series.
    * @param n >= 0
    * @return the nth element, >= 0.
    */
    function fib(n) {
        
      var a = 1, b = 1;
      var tmp;
      while (--n >= 0) {
        
        tmp = a;
        a += b;
        b = tmp;
      }
      return a;
    }
    
    document.write(fib(10));

#### 7. 流程图 ####

##### 示例 #####

Created with Raphaël 2.3.0  Start verificationYour OperationYes or No?EndYour Subroutineyesno

更多语法参考：[流程图语法参考][Link 2]

#### 8. 序列图 ####

##### 示例 1 #####

Alice->Bob: Hello Bob, how are you?
    Note right of Bob: Bob thinks
    Bob-->Alice: I am good thanks!

##### 示例 2 #####

Title: Here is a title
    A->B: Normal line
    B-->C: Dashed line
    C->>D: Open arrow
    D-->>A: Dashed open arrow

更多语法参考：[序列图语法参考][Link 3]

#### 9. 甘特图 ####

甘特图内在思想简单。基本是一条线条图，横轴表示时间，纵轴表示活动（项目），线条表示在整个期间上计划和实际的活动完成情况。它直观地表明任务计划在什么时候进行，及实际进展与计划要求的对比。

title 项目开发流程
        section 项目确定
            需求分析       :a1, 2016-06-22, 3d
            可行性报告     :after a1, 5d
            概念验证       : 5d
        section 项目实施
            概要设计      :2016-07-05  , 5d
            详细设计      :2016-07-08, 10d
            编码          :2016-07-15, 10d
            测试          :2016-07-22, 5d
        section 发布验收
            发布: 2d
            验收: 3d

更多语法参考：[甘特图语法参考][Link 4]

#### 10. Mermaid 流程图 ####

A[Hard edge] -->|Link text| B(Round edge)
        B --> C{Decision}
        C -->|One| D[Result one]
        C -->|Two| E[Result two]

更多语法参考：[Mermaid 流程图语法参考][Mermaid]

#### 11. Mermaid 序列图 ####

AliceJohnHello John, how are you?Great!loop\[every minute\]AliceJohn

更多语法参考：[Mermaid 序列图语法参考][Mermaid 1]

#### 12. 表格支持 ####

#### 13. 定义型列表 ####

名词 1

定义 1（左侧有一个可见的冒号和四个不可见的空格）

代码块 2

这是代码块的定义（左侧有一个可见的冒号和四个不可见的空格）

代码块（左侧有八个不可见的空格）

#### 14. Html 标签 ####

本站支持在 Markdown 语法中嵌套 Html 标签，譬如，你可以用 Html 写一个纵跨两行的表格：

#### 15. 内嵌图标 ####

本站的图标系统对外开放，在文档中输入

即显示微博的图标：

替换 上述 `i 标签` 内的 `icon-weibo` 以显示不同的图标，例如：

即显示人人的图标：

更多的图标和玩法可以参看 [font-awesome][] 官方网站。

#### 16. 待办事宜 Todo 列表 ####

使用带有 \[ \] 或 \[x\] （未完成或已完成）项的列表语法撰写一个待办事宜列表，并且支持子列表嵌套以及混用Markdown语法，例如：

- [ ] **Cmd Markdown 开发**
        - [ ] 改进 Cmd 渲染算法，使用局部渲染技术提高渲染效率
        - [ ] 支持以 PDF 格式导出文稿
        - [x] 新增Todo列表功能 [语法参考](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments)
        - [x] 改进 LaTex 功能
            - [x] 修复 LaTex 公式渲染问题
            - [x] 新增 LaTex 公式编号功能 [语法参考](http://docs.mathjax.org/en/latest/tex.html#tex-eq-numbers)
    - [ ] **七月旅行准备**
        - [ ] 准备邮轮上需要携带的物品
        - [ ] 浏览日本免税店的物品
        - [x] 购买蓝宝石公主号七月一日的船票

对应显示如下待办事宜 Todo 列表：

*  **Cmd Markdown 开发**
    
     *  改进 Cmd 渲染算法，使用局部渲染技术提高渲染效率
     *  支持以 PDF 格式导出文稿
     *  新增Todo列表功能 [语法参考][Link 5]
     *  改进 LaTex 功能
        
         *  修复 LaTex 公式渲染问题
         *  新增 LaTex 公式编号功能 [语法参考][Link 6]
 *  **七月旅行准备**
    
     *  准备邮轮上需要携带的物品
     *  浏览日本免税店的物品
     *  购买蓝宝石公主号七月一日的船票

**更多MarkDown语法请参见**：

[MarkDown简明语法公式][MarkDown]

[MarkDown高阶语法公式][Link 1]

[MarkDown公式指导手册][MarkDown 1]

**学习更多编程知识，请关注我的公众号：**

[代码的路][Link 7]

![在这里插入图片描述][98b0fdeea99b4253aa18ebde204413eb.png]

--------------------

1.  这是一个 *注脚* 的 **文本**。 ↩︎
2.  这是另一个 *注脚* 的 **文本**。 ↩︎

[Link 1]: https://mp.weixin.qq.com/s/L9WI8zMlPWdqUsyh36vUhA
[MathJax]: http://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference
[Link 2]: http://adrai.github.io/flowchart.js/
[Link 3]: http://bramp.github.io/js-sequence-diagrams/
[Link 4]: https://knsv.github.io/mermaid/#gant-diagrams
[Mermaid]: https://knsv.github.io/mermaid/#flowcharts-basic-syntax
[Mermaid 1]: https://knsv.github.io/mermaid/#sequence-diagrams
[font-awesome]: http://fortawesome.github.io/Font-Awesome/3.2.1/icons/
[Link 5]: https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments
[Link 6]: http://docs.mathjax.org/en/latest/tex.html#tex-eq-numbers
[MarkDown]: https://mp.weixin.qq.com/s/81VNMKLLqfI_rik__qn2ZA
[MarkDown 1]: https://mp.weixin.qq.com/s/rAut9IAmBFtSW8iv38OOWA
[Link 7]: https://mp.weixin.qq.com/s/t0t89DFgJ1TEzI4uI5giHg
[98b0fdeea99b4253aa18ebde204413eb.png]: https://img-blog.csdnimg.cn/98b0fdeea99b4253aa18ebde204413eb.png