Markdown Editor Syntax
Machine-translated (anthropic, claude-haiku-5-5) from the Chinese original. Read the original in 中文
Contents
Preface
Markdown is a lightweight "markup language" commonly used by programmers. It is now the go-to writing format for GitHub, the world's largest technical sharing website, and StackOverflow, the technical Q&A site.
What can I do
① Code highlighting
② Create a To-do List
③ Efficiently draw flowcharts, sequence diagrams, Gantt charts, and tables
Flowchart:
Sequence diagram:
Gantt chart:
Table:
④ Write mathematical formulas
Common Usage
0x01 Headings
In Markdown, to define a piece of text as a heading, simply add # in front of the text, followed by a space after #. There are six heading levels in total. To get a lower-level heading, add one more #; each additional # reduces the heading size by one level. As shown:
0x02 Lists
List formatting is very common and can keep your document well organized. In Markdown, simply add - in front of the text; if you want an ordered list, add 1. 2. 3. in front of the text.
Note: Keep one character's space between -, 1., and the text.
0x03 Quotes
If you need to quote a sentence from elsewhere in your document, use the "quote" format.
Add > in front of the quoted text, with one character's space between them.
0x04 Bold and Italic
Bold and italic in Markdown are also very simple:
Enclosing a piece of text with two * is the syntax for bold;
Enclosing a piece of text with one * is the syntax for italic.
0x05 Links and Images
Links: In Markdown, to insert a link, simply use [显示文本](链接地址).
Images: In Markdown, to insert an image, simply use .
Note: The syntax for inserting an image is very similar to that for links, except with an extra ! in front.
0x06 Font, Font Size, and Color
<font face="黑体">我是黑体字</font>
<font face="微软雅黑">我是微软雅黑</font>
<font face="STCAIYUN">我是华文彩云</font>
<font color=#0099ff size=3 face="黑体">color=#0099ff size=72 face="黑体"</font>
<font color=#00ffff size=3>color=#00ffff</font>
<font color=gray size=3>color=gray</font>Size: Specifies the size of the text. Possible values: numbers from 1 to 7. The browser default is 3.
For color codes, see: Color codes
Comments