[toc=2] # markdown語法文檔 * [看云](https://help.kancloud.cn/41501) * [馬克飛象](https://maxiang.io/#/?id=readme) * [作業部落](https://www.zybuluo.com/mdeditor#) # 常用基本語法 ## H1~H6 #### markdown語法 ```markdown # H1文字 ## H2文字 ### H3文字 #### H4文字 ##### H5文字 ###### H6文字 ``` #### 快捷操作 * CTRL+1 ~ CTRL+6 *  ## 粗體 #### markdown語法 ```markdown **粗體內容** ``` #### 快捷操作 * CTRL+B *  ## 斜體 #### markdown語法 ```markdown _斜體內容_ *斜體內容* ``` #### 快捷操作 * CTRL+I *  ## 無序列表 #### markdown語法 ```markdown * 列表項1 * 列表項2 * 列表項3 * 列表項4 ``` ```markdown * 列表項1 * 列表項2 * 子列表項1 * 子列表項2 ``` #### 快捷操作 * CTRL+ALT+U *  ## 有序列表 #### markdown語法 ```markdown 1. 列表項1 2. 列表項2 3. 列表項3 4. 列表項4 ``` ```markdown 1. 列表項1 2. 列表項2 1. 子列表項1 2. 子列表項2 ``` #### 快捷操作 * CTRL+ALT+O *  ## 鏈接 #### markdown語法 ```markdown [鏈接文字](http://www.hmoore.net) 看云的網址是：http://www.hmoore.net [寫作規范](寫作規范.md) ``` #### 快捷操作 * CTRL+L *  #### 注意事項 >[danger] 網址前后加上空格可以避免混淆 ## 腳注 #### markdown語法 ```markdown 看云是一個文檔寫作[^write]和托管平臺[^platform]。 // 中間可以添加其他內容 [^write]: 寫作格式采用Markdown格式，支持版本和多人寫作。 [^platform]: 發布的文檔可以直接在平臺閱讀、分享和私有存儲，并支持付費閱讀。 ``` ## 圖片 #### markdown語法 ```markdown   ``` #### 快捷操作 * CTRL+ALT+Y *  * 剪切板直接粘貼 ## 代碼 #### markdown語法 ```markdown 單行代碼 `define('APP_DEBUG', false);` ``` ```markdown 多行代碼： ~~~ // 系統常量定義 defined('THINK_PATH') or define('THINK_PATH', __DIR__.'/'); defined('APP_PATH') or define('APP_PATH', dirname($_SERVER['SCRIPT_FILENAME']).'/'); defined('APP_STATUS') or define('APP_STATUS', ''); // 應用狀態 加載對應的配置文件 defined('APP_DEBUG') or define('APP_DEBUG', false); // 是否調試模式 ~~~ ``` ```markdown 多行代碼： ~~~php // 系統常量定義 defined('THINK_PATH') or define('THINK_PATH', __DIR__.'/'); defined('APP_PATH') or define('APP_PATH', dirname($_SERVER['SCRIPT_FILENAME']).'/'); defined('APP_STATUS') or define('APP_STATUS', ''); // 應用狀態 加載對應的配置文件 defined('APP_DEBUG') or define('APP_DEBUG', false); // 是否調試模式 ~~~ ``` #### 快捷操作 * CTRL+E *  ## 分割線 #### markdown語法 ```markdown * * * * * --- ``` #### 快捷操作 * CTRL+H *  ## 引用 #### markdown語法 ```markdown > 這是一段引用內容文字 > 這是第二行引用內容文字 > 這是第三行引用內容文字 ``` ```markdown > 這是一段引用內容文字 **粗體內容** > 這是第二行引用內容文字 _斜體內容_ > 這是第三行引用內容文字 `單行代碼` > [這是一個鏈接](http://www.hmoore.net) ``` ```markdown > 引用內容 > > > 子引用內容 > > 子引用內容 ``` ```markdown >[info] 這里是**提示信息** >通常用于一些提醒事項 ``` ```markdown >[warning] 這里是**警告信息** >通常用于一些警告事項 ``` ```markdown >[success] 這里是**成功信息** >通常用于一些成功提示 ``` ```markdown >[danger] 這里是**危險信息** >需要引起特別的注意 ``` #### 快捷操作 * CTRL+Q *  ## 段落排版 #### markdown語法 ```markdown 這是一個居左的段落 :-: 這是一個居中的段落 --: 這是一個居右的段落 >[info] --: 這里是居右的引用內容 :-:  :-: 圖片居中 ``` #### 快捷操作 * 居左（CTRL+ALT+L）、居中（CTRL+ALT+E）和居右（CTRL+ALT+R） *  ## 注釋 #### markdown語法 ```markdown // 這是一個注釋內容 注釋段落內容 這個段落是可見的 ``` ## 表格 #### markdown語法 ```markdown | 編號 | 產品 | 描述 | |---|---|---| | 1 | ThinkPHP | 開源WEB應用框架 | | 2 | OneThink | 開源內容管理框架 | | 3 | 看云 | 文檔托管平臺 | ``` ```markdown | 編號（居右對齊） | 產品（居中對齊） | 描述（居左對齊） | | ---: | :---: | :--- | | 1 | ThinkPHP | 開源WEB應用框架 | | 2 | OneThink | 開源內容管理框架 | | 3 | 看云 | 文檔托管平臺 | ``` #### 快捷操作 *  ## 流程圖和時序圖 >[danger] 首先需要配置文檔, 使其支持流程圖和時序圖  #### markdown語法 ```[flow] st=>start: Start:>http://www.google.com[blank] e=>end:>http://www.google.com op1=>operation: My Operation sub1=>subroutine: My Subroutine cond=>condition: Yes or No?:>http://www.google.com io=>inputoutput: catch something... st->op1->cond cond(yes)->io->e cond(no)->sub1(right)->op1 ```  ```[sequence] Title: Here is a title A->B: Normal line B-->C: Dashed line C->>D: Open arrow D-->>A: Dashed open arrow ```  ## 目錄導航 #### markdown語法 ```markdown [toc] [TOC=2] // 提取H1到H2的內容顯示 [TOC=3] // 提取H1到H3的內容顯示 [TOC=2,3] // 提取H2到H3的內容顯示 ``` >[danger] 注意：[TOC] 后面必須增加一個空行才能正確顯示目錄結構 #### 快捷操作 *  ## 撤銷和重做 #### 快捷操作 * CTRL+Z 和 CTRL+Y *  ## 全文預覽 * 文檔在沒有發布之前，其它用戶是無法閱讀的，但作者或者文檔成員中具有編輯以上權限的用戶（包括創始人、管理員和編輯）可以進行預覽操作。 * 點擊右上角的全文預覽按鈕 可以進行和最終閱讀效果一致的全文預覽。 ## 同步內容 * 編輯過程中不需要進行保存操作，系統會自動保存到該文檔的暫存區，只有在點擊同步操作的時候才會實際提交到版本庫，如果需要同步內容，可以隨時點擊編輯器工具欄上的 。 * 默認情況下該按鈕呈灰色狀態 ，當有內容更新后，會自動顯示為 說明這個時候可以進行同步操作。 # 學習markdown的小技巧 * 打開一個可以實時預覽的頁面 * 根據自己的印象敲代碼, 想到什么就敲什么 * 能敲出來的, 都是你已經記住并理解的 * 找到那些有印象, 但是沒能敲對的, 加深記憶, 然后再測試 * 通讀一遍文檔, 對于那些連印象都沒有的語法, 加強學習和記憶, 然后測試 * 多練, 多測試