Markdown基本語法及生成目錄結構的方法

時間 2020-08-11

原文原文鏈接

Markdown是一種純文本格式的標記語言。經過簡單的標記語法，它可使普通文本內容具備必定的格式。html

1、標題

在想要設置爲標題的文字前面加#來表示
一個#是一級標題，二個#是二級標題，以此類推。支持六級標題。node

注：標準語法通常在#後跟個空格再寫文字。git

示例：npm

# 這是一級標題
## 這是二級標題
### 這是三級標題
#### 這是四級標題
##### 這是五級標題
###### 這是六級標題

效果：json

2、字體

加粗vim

要加粗的文字左右分別用兩個*號包起來api

斜體markdown

要傾斜的文字左右分別用一個*號包起來app

斜體加粗post

要傾斜和加粗的文字左右分別用三個*號包起來

刪除線

要加刪除線的文字左右分別用兩個~~號包起來

示例：

**這是加粗的文字**
*這是傾斜的文字*`
***這是斜體加粗的文字***
~~這是加刪除線的文字~~

效果：

3、引用

在引用的文字前加>便可。引用也能夠嵌套，如加兩個>>三個>>>

示例：

> 這是引用的內容1
>> 這是引用的內容2
>>> 這是引用的內容3

效果：

4、分割線

三個或者三個以上的 - 或者 * 均可以。

示例：

---
----
***
*****

效果：

5、圖片

語法：

![圖片alt](圖片地址 "圖片title")

示例：

![百度](https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png "baidu")

效果：

6、超連接

語法：

[超連接名](超連接地址 "超連接title")

示例：

[百度](http://www.baidu.com "百度")

效果：

7、列表

1.無序列表

語法：

- 列表內容
+ 列表內容
* 列表內容

注意：- + * 跟內容之間都要有一個空格

示例：

- 列表內容
+ 列表內容
* 列表內容

效果：

2.有序列表

語法：

1. 列表內容
2. 列表內容
3. 列表內容

注意：序號跟內容之間要有空格

示例：

1. 列表內容
2. 列表內容
3. 列表內容

效果：

3.列表嵌套

語法：

* 列表1
   * 列表1.1
   * 列表1.2
   * 列表1.3
* 列表2
   * 列表2.1
   * 列表2.2
   * 列表2.3

上一級和下一級之間敲三個空格便可

示例：

* 列表1
   * 列表1.1
   * 列表1.2
   * 列表1.3
* 列表2
   * 列表2.1
   * 列表2.2
   * 列表2.3

效果：

8、表格

語法：

表頭|表頭|表頭
---|:--:|---:
內容|內容|內容
內容|內容|內容

第二行分割表頭和內容。
- 有一個就行，爲了對齊，多加了幾個
文字默認居左
-兩邊加：表示文字居中
-右邊加：表示文字居右
注：原生的語法兩邊都要用 | 包起來。此處省略

示例：

|姓名|年齡|排行|
|--|:--:|--:|
甲|25|3
丙|27|1
乙|26|2

效果：

9、代碼

語法：

單行代碼：代碼之間分別用一個反引號包起來

代碼塊：代碼之間分別用三個反引號包起來，且兩邊的反引號單獨佔一行

示例：

`console.log('單行代碼塊')`
```
function fun(){
  console.log('多行代碼塊');
}
fun();
```

效果：

10、流程圖

語法：

tag=>type: content:>url

tag就是元素名字，type是這個元素的類型，有6中類型，分別爲：

start # 開始
end # 結束
operation # 操做
subroutine # 子程序
condition # 條件
inputoutput # 輸入或產出

url是一個鏈接，與框框中的文本相綁定，content就是在框框中要寫的內容，注意type後的冒號與文本之間必定要有個空格。

鏈接元素的語法：

用->來鏈接兩個元素，須要注意的是condition類型，由於他有yes和no兩個分支，因此要寫成

cond(yes)->e 
cond(no)->op

示例：

```flow
st=>start: Start
op=>operation: Your Operation
cond=>condition: Yes or No?
e=>end
st->op->cond
cond(yes)->e
cond(no)->op
```

效果：

11、markdown生成目錄結構的方法：

示例：

```
project
│   README.md
│   file001.txt    
│
└───folder1
│   │   file011.txt
│   │   file012.txt
│   │
│   └───subfolder1
│       │   file111.txt
│       │   file112.txt
│       │   ...
│   
└───folder2
    │   file021.txt
    │   file022.txt
```

咱們常常會看到上面這種【目錄&文件結構】在頁面上很是整齊地輸出，下面來講一下怎麼這種生成目錄結構。

使用一個Node模塊來自動完成這個任務：mddir

1.安裝mddir包

npm install mddir --save

2.打開終端或命令提示符，並cd進入mddir /src文件夾

3.執行 node mddir "../../../"

示例：

```
$ cd ~/Documents/demo-project
$ pwd
Users/username/Documents/demo-project
$ npm install mddir --save
$ cd node_modules/mddir/src
$ pwd
Users/username/Documents/node_modules/mddir/src
$ ls
mddir.js
$ node mddir "../../../"
// Exports 'directoryList.md' in mddir/src folder
```

若是沒有指定路徑，mddir將默認爲mddir/src文件夾之上上的三個文件夾(假設mddir安裝在：project/node_modules/mddir/src中)。

目前忽略node_modules和.git文件夾。

示例生成的markdown文件結構'directoryList.md'

    |-- .bowerrc
    |-- .jshintrc
    |-- .jshintrc2
    |-- Gruntfile.js
    |-- README.md
    |-- bower.json
    |-- karma.conf.js
    |-- package.json
    |-- app
        |-- app.js
        |-- db.js
        |-- directoryList.md
        |-- index.html
        |-- mddir.js
        |-- routing.js
        |-- server.js
        |-- _api
            |-- api.groups.js
            |-- api.posts.js
            |-- api.users.js
            |-- api.widgets.js
        |-- _components
            |-- directives
                |-- directives.module.js
                |-- vendor
                    |-- directive.draganddrop.js
            |-- helpers
                |-- helpers.module.js
                |-- proprietary
                    |-- factory.actionDispatcher.js
            |-- services
                |-- services.cardTemplates.js
                |-- services.cards.js
                |-- services.groups.js
                |-- services.posts.js
                |-- services.users.js
                |-- services.widgets.js
        |-- _mocks
            |-- mocks.groups.js
            |-- mocks.posts.js
            |-- mocks.users.js
            |-- mocks.widgets.js