What is MarkDown
Plain Text Markup Language, a simple markup syntax, the plain text content has a certain format
Why MarkDown
- Small size, similar to the TXT file
- To create easy, simple to use
- Beautiful than ordinary TXT text
- Convenient recording, various code references, references pictures, more convenient than TXT, Word smaller than
How to use MarkDown
Download Editor
https://zhuanlan.zhihu.com/p/69210764
- MarkdownPad(http://markdownpad.com/)
- BookPad(https://www.microsoft.com/zh-cn/p/bookpad/9n6p5zh2sjsx?rtc=1&activetab=pivot:overviewtab)
- The Little Book Carpenter ( http://soft.xiaoshujiang.com/ )
- Typora ( https://typora.io/ )
- Visual Studio Code(https://code.visualstudio.com/)
- Marxico(https://marxi.co/)
- Sublime Text 3(https://www.sublimetext.com/3)
- Mou(http://25.io/mou/)
- Atom(https://atom.io/)
- Smark(https://github.com/elerao/Smark)
- Haroopad(http://pad.haroopress.com/)
File creation
Create a TXT file, you can name suffix md
MarkDown grammar
title
The number represents the title of the series plus text #
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
Fonts
Italic
* Text around with a wrap
*斜体*
Italic
Bold
* Text about two wrap
**加粗**
Bold
Bold italic
***斜体加粗***
Bold italic
* Text with about three wrap
Strikethrough
Text with the left and right two wrap ~
~~删除线~~
Strikethrough
Quote
Preceded quoted text>, can be nested
>引用文本
Quoted text
Dividing line
More than three - or *
---
***
image
Can be directly pasted pictures
![图片alt](图片地址 ''图片title'')
图片alt就是显示在图片下面的文字,相当于对图片内容的解释。
图片title是图片的标题,当鼠标移到图片上时显示的内容。title可加可不加
Hyperlink
[超链接名](超链接地址 "超链接title")
title可加可不加
List
Ordered list
Digital plus.
1. 有序列表
- An ordered list
- An ordered list of two
- An ordered list of three
Unordered list
-+*
- 无序列表
+ 无序列表
* 无序列表
A unordered list
List two wireless
No need to list three
To Do List
- [ ]Upcoming
- [X] completed
Nested list
Three spaces between the previous and the next level
form
表头|表头|表头
---|:--:|---:
内容|内容|内容
内容|内容|内容
第二行分割表头和内容。
- 有一个就行,为了对齐,多加了几个
文字默认居左
-两边加:表示文字居中
-右边加:表示文字居右
注:原生的语法两边都要用 | 包起来。此处省略
Numbering | Full name | Remark |
---|---|---|
001 | Joe Smith | AAA |
002 | John Doe | BBB |
003 | Wang Wu | CCC |
Code
Single line of code
Between the code with the `wrap
代码1
Lines of code
Between the code with the three `wrap
Plus three `code language
```json ```java
flow chart
```flow
st=>start: 开始
op=>operation: My Operation
cond=>condition: Yes or No?
e=>end
st->op->cond
cond(yes)->e
cond(no)->op
&```
Timing diagram
```graph
sequenceDiagram
participant Alice
participant Bob
Alice->John: Hello John, how are you?
loop Healthcheck
John->John: Fight against hypochondria
end
Note right of John: Rational thoughts
prevail...
John-->Alice: Great!
John->Bob: How about you?
Bob-->John: Jolly good!
```
Gantt chart
```graph
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to mermaid
section A section
Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d
Future task : des3, after des2, 5d
Future task2 : des4, after des3, 5d
section Critical tasks
Completed task in the critical line :crit, done, 2014-01-06,24h
Implement parser and jison :crit, done, after des1, 2d
Create tests for parser :crit, active, 3d
Future task in critical line :crit, 5d
Create tests for renderer :2d
Add to mermaid :1d
```