[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.kancloud.cn) 看云的网址是：http://www.kancloud.cn [写作规范](写作规范.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.kancloud.cn) ``` ```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的小技巧 * 打开一个可以实时预览的页面 * 根据自己的印象敲代码, 想到什么就敲什么 * 能敲出来的, 都是你已经记住并理解的 * 找到那些有印象, 但是没能敲对的, 加深记忆, 然后再测试 * 通读一遍文档, 对于那些连印象都没有的语法, 加强学习和记忆, 然后测试 * 多练, 多测试