MarkDown Advanced Syntax Manual

Original link

1. Content Directory

Fill in the paragraph [TOC] to show the directory structure of the full text content.

[TOC]

2. Tag Classification

Enter the following code at the beginning of any row in the editing area to label the document:

Tags: MathEnglishMarkdown

or

Tags: Math English Markdown

3. Strikethrough

Use ~~ for strikethrough.

This is an incorrect piece of text.

4. Footnotes

Use [^keyword] for footnotes.

This is an example of footnote ¹ .

This is an example of the second footnote ² .

5. LaTeX formulas

"$" represents an inline formula:

The mass-energy conservation equation can be expressed in a very concise equation $E=mc^2$.

"$$" means the whole line formula:

$$ \sum_{i=1}^n a_i=0 $$

$$ f(x_1,x_x,\ldots,x_n) = x_1^2 + x_2^2 + \cdots + x_n^2 $$

$$ \sum^{j-1}_{k=0}{\widehat{\gamma}_{kj} z_k} $$

Visit MathJax for more usage.

6. Enhanced code blocks

Syntax highlighting and line number display for forty-one programming languages are supported.

Non-code example:

 $ sudo apt-get install vim-gnome

Python example:

 @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 example:

 /**
* 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. Flowchart

Example

 st=>start: Start:>https://www.zybuluo.com
io=>inputoutput: verification
op=>operation: Your Operation
cond=>condition: Yes or No?
sub=>subroutine: Your Subroutine
e=>end

st->io->op->cond
cond(yes)->e
cond(no)->sub->io

More syntax reference: Flowchart syntax reference

8. Sequence diagram

Example 1

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

Example 2

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

More syntax references: Sequence Diagram Syntax Reference

9. Gantt Chart

The Gantt chart has a simple inner thought. Basically a line graph, the horizontal axis represents time, the vertical axis represents activities (projects), and the lines represent planned and actual completion of activities over the entire period. It provides a visual indication of when the mission is planned and how actual progress compares to planned requirements.

 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

More syntax references: Gantt Chart Syntax Reference

10. Mermaid Flowchart

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

More syntax reference: Mermaid flowchart syntax reference

11. Mermaid Sequence Diagram

 Alice->John: Hello John, how are you?
    loop every minute
        John-->Alice: Great!
    end

More syntax reference: Mermaid Sequence Diagram Syntax Reference

12. Form Support

project	price	quantity
computer	$1600	5
cell phone	$12	12
pipeline	$1	234

13. Defined Lists

noun 1
: Definition 1 (with a visible colon and four invisible spaces on the left)

code block 2
: This is the definition of the code block (with a visible colon on the left and four invisible spaces)

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

14. Html tags

This site supports nesting Html tags in Markdown syntax. For example, you can use Html to write a table that spans two lines:

 <table>
    <tr>
        <th rowspan="2">值班人员</th>
        <th>星期一</th>
        <th>星期二</th>
        <th>星期三</th>
    </tr>
    <tr>
        <td>李强</td>
        <td>张明</td>
        <td>王平</td>
    </tr>
</table>


le>
<tr>
    <th rowspan="2">值班人员</th>
    <th>星期一</th>
    <th>星期二</th>
    <th>星期三</th>
</tr>
<tr>
    <td>李强</td>
    <td>张明</td>
    <td>王平</td>
</tr>
ble>

15. Inline Icons

The icon system of this site is open to the outside world, input in the document

 <i class="icon-weibo"></i>

That is, the icon of Weibo is displayed:

Replace i 标签 icon-weibo to display a different icon, for example:

 <i class="icon-renren"></i>

That is, the icon of everyone is displayed:

For more icons and gameplay, please refer to the font-awesome official website.

16. Todo list

Compose a to-do list using list syntax with [ ] or [x] (unfinished or completed) items, and supports nested sublists and mixed Markdown syntax, for example:

 - [ ] **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] 购买蓝宝石公主号七月一日的船票

Correspondingly, the following Todo list is displayed:

• [ ] Cmd Markdown development

  • [ ] Improve Cmd rendering algorithm, use local rendering technology to improve rendering efficiency
  • [ ] Supports exporting documents in PDF format
  • [x] Added Todo list function syntax reference

  • [x] Improve LaTex functionality

    • [x] Fix LaTex formula rendering issue
    • [x] Added LaTex formula number function syntax reference

• [ ] July travel preparation

  • [ ] Prepare the items to be carried on the cruise
  • [ ] Browse items in duty free shops in Japan
  • [x] Purchase Sapphire Princess ferry tickets on July 1

For more MarkDown syntax, see :

MarkDown Concise Syntax Formula

MarkDown higher-order syntax formulas

MarkDown Formula Instruction Manual

To learn more programming knowledge, please pay attention to my public account:

the way of code

---

1. This is the text of a footnote . ↩
2. This is the text of another footnote . ↩