Markdown edit syntax

Posted by garty on Sat, 11 Sep 2021 07:29:15 +0200

Markdown concise grammar manual

Tag: CMD markdown

1. Italics and bold

Use * and * * for italics and bold.


This is italic and this is bold.

2. Hierarchical title

Use = = = to indicate the primary title, and - to indicate the secondary title.


This is a primary title

This is a secondary title

### This is a three-level title

You can also choose to add a pound sign at the beginning of the line to indicate different levels of titles (H1-H6), for example: # H1, ## H2, ### H3, #### H4.

3. External links

Use [description] (link address) to add an external link to the text.


This is going to My blog Link to.

4. Unordered list

Use *, +, - to represent an unordered list.


  • Unordered list item 1
  • Unordered list item 2
  • Unordered list item 3

5. Ordered list

Use numbers and dots to represent an ordered list.


  1. Ordered list item 1
  2. Ordered list item 2
  3. There are three items in the sequence table

6. Text reference

Use > to represent a text reference.


The wild fire never burns out, and the spring breeze blows again.

7. In line code block

Use 'code' to represent inline code blocks.


Let's talk about html.

8. Code block

Use four indented spaces to represent the code block.


This is a block of code with four invisible spaces to the left of the line.

9. Insert image

use! [description] (picture link address) inserts an image.


[the external chain picture transfer fails. The source station may have an anti-theft chain mechanism. It is recommended to save the picture and upload it directly (img-uMvm3EMf-1631275598424)(Markdown editing syntax. assets/my_head.jpg)]

Cmd Markdown Advanced Grammar manual

1. Contents

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

2. Label classification

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

Label: mathematical English Markdown


Tags: mathematical English Markdown

3. Delete line

Use ~ ~ to indicate a strikethrough.

This is an incorrect text.

4. Footnotes

Use [^ keyword] to represent footnotes.

This is a footnote 1 An example of.

This is the second footnote 2 An example of.

5. LaTeX formula

$indicates in-line formula:

The conservation equation of mass and energy can use a very simple equation E = m c 2 E=mc^2 E=mc2.

$$indicates the whole line formula:

∑ i = 1 n a i = 0 \sum_{i=1}^n a_i=0 i=1∑n​ai​=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​γ ​kj​zk​

visit MathJax Refer to more usage methods.

6. Enhanced code block

Support syntax highlighting and line number display of 41 programming languages.

Non code examples:

$ sudo apt-get install vim-gnome

Python example:

def somefunc(param1='', param2=0):
    '''A docstring'''
    if param1 > param2: # interesting
        print 'Greater'
    return (param2 - param1 + 1) or None

class SomeClass:

>>> 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;


7. Flow chart


More syntax References: 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

Ganttney is simple in thought. It is basically a line chart. The horizontal axis represents the time, the vertical axis represents the activity (project), and the line represents the completion of planned and actual activities in the whole period. It intuitively shows when the task plan is carried out and the comparison between the actual progress and the plan requirements.

    title Project development process
    section Project determination
        requirement analysis       :a1, 2016-06-22, 3d
        Feasibility report     :after a1, 5d
        Proof of concept       : 5d
    section project implementation 
        Outline design      :2016-07-05  , 5d
        detailed design       :2016-07-08, 10d
        code          :2016-07-15, 10d
        test          :2016-07-22, 5d
    section Release and acceptance
        release: 2d
        check before acceptance: 3d

More syntax References: Gantt chart syntax reference

10. Mermaid flow chart

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

More syntax References: Mermaid flowchart syntax reference

11. Mermaid sequence diagram

More syntax References: Mermaid sequence diagram syntax reference

12. Form support

mobile phone$1212

13. Definition list

Noun 1

Definition 1 (one visible colon and four invisible spaces on the left)

Code block 2

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

  Code block (eight invisible spaces on the left)

14. Html label

This site supports nesting Html tags in Markdown syntax. For example, you can write a table with two rows in Html:

        <th rowspan="2">Personnel on duty</th>
        <td>Li Qiang</td>
        <td>Zhang Ming</td>
        <td>Wang Ping</td>
Personnel on dutyMondayTuesdayWednesday
Li QiangZhang MingWang Ping

15. Embedded Icon

The icon system of this site is open to the public and can be entered in the document

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

The icon of microblog is displayed:

Replace the icon Weibo in the above i tag to display different icons, for example:

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

The icon for everyone is displayed:

For more icons and gameplay, see font-awesome Official website.

16. To do Todo list

Write a to-do list using the list syntax with [] or [x] (incomplete or completed) items, and support sub list nesting and mixed Markdown syntax, such as:

- [ ] **Cmd Markdown development**
    - [ ] improvement Cmd Rendering algorithm, using local rendering technology to improve rendering efficiency
    - [ ] Support to PDF Export document in format
    - [x] newly added Todo List function [Grammatical reference](
    - [x] improvement LaTex function
        - [x] repair LaTex Formula rendering problem
        - [x] newly added LaTex Formula numbering function [Grammatical reference](
- [ ] **Travel preparation in July**
    - [ ] Prepare items to be carried on the cruise ship
    - [ ] Browse Japanese duty-free shops
    - [x] Buy tickets for the Sapphire Princess on July 1

The following Todo list of to-do items is displayed accordingly:

  • Cmd Markdown development
    • Improve Cmd rendering algorithm and use local rendering technology to improve rendering efficiency
    • Supports exporting documents in PDF format
    • New Todo list function Grammatical reference
    • Improved LaTex functionality
  • Travel preparation in July
    • Prepare items to be carried on the cruise ship
    • Browse Japanese duty-free shops
    • Buy tickets for the Sapphire Princess on July 1
  1. This is a footnote text. ↩︎

  2. This is the text of another footnote. ↩︎

Topics: markdown