├── CNAME ├── README.md └── docs ├── .nojekyll ├── CNAME ├── README.md ├── _coverpage.md └── index.html /CNAME: -------------------------------------------------------------------------------- 1 | markdown-syntax.com -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![](https://cdoco.com/images/markdown-syntax.png) 2 | 3 | ## 什么是 Markdown ? 4 | 5 | > Markdown 是一种可以使用普通文本编辑器编写的标记语言, 通过简单的标记语法, 它可以使普通文本内容具有一定的格式。 6 | 7 | ## 目录 8 | 9 | - [分级标题](#分级标题) 10 | - [分隔线](#分隔线) 11 | - [超链接](#超链接) 12 | - [行内式](#行内式) 13 | - [参考式](#参考式) 14 | - [自动链接](#自动链接) 15 | - [区块引用](#区块引用) 16 | - [引用的多层嵌套](#引用的多层嵌套) 17 | - [引用其它要素](#引用其它要素) 18 | - [锚点](#锚点) 19 | - [强调](#强调) 20 | - [斜体](#斜体) 21 | - [粗体](#粗体) 22 | - [删除线](#删除线) 23 | - [列表](#列表) 24 | - [无序列表](#无序列表) 25 | - [有序列表](#有序列表) 26 | - [包含引用的列表](#包含引用的列表) 27 | - [插入图片](#插入图片) 28 | - [图片行内式](#图片行内式) 29 | - [图片参考式](#图片参考式) 30 | - [表格](#表格) 31 | - [代码](#代码) 32 | - [代码行内式](#代码行内式) 33 | - [缩进式多行代码](#缩进式多行代码) 34 | - [用六个`包裹多行代码](#用六个--包裹多行代码) 35 | - [HTML 原始码](#html-原始码) 36 | - [内容目录](#内容目录) 37 | - [注脚](#注脚) 38 | - [LaTeX 公式](#latex-公式) 39 | - [$ 表示行内公式](#-表示行内公式) 40 | - [$$ 表示整行公式](#-表示整行公式) 41 | - [流程图](#流程图) 42 | - [时序图](#时序图) 43 | - [待办事宜列表](#待办事宜列表) 44 | 45 | ## 分级标题 46 | 47 | 第一种写法: 48 | 49 | ```markdown 50 | 这是一个一级标题 51 | ============================ 52 | 53 | 这是一个二级标题 54 | -------------------------------------------------- 55 | ``` 56 | 57 | > 这是一个一级标题 58 | > ============================ 59 | > 这是一个二级标题 60 | > -------------------------------------------------- 61 | 62 | --- 63 | 64 | 第二种写法: 65 | 66 | ```markdown 67 | # 一级标题 68 | ## 二级标题 69 | ### 三级标题 70 | #### 四级标题 71 | ##### 五级标题 72 | ###### 六级标题 73 | ``` 74 | 75 | > # 一级标题 76 | > ## 二级标题 77 | > ### 三级标题 78 | > #### 四级标题 79 | > ##### 五级标题 80 | > ###### 六级标题 81 | 82 | ## 分隔线 83 | 84 | 你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线, 行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线: 85 | 86 | ``` markdown 87 | * * * 88 | 89 | *** 90 | 91 | ***** 92 | 93 | - - - 94 | 95 | --------------------------------------- 96 | ``` 97 | 98 | > * * * 99 | > - - - 100 | 101 | ## 超链接 102 | 103 | Markdown 支持两种形式的链接语法: 行内式和参考式两种形式, 行内式一般使用较多。 104 | 105 | ### 行内式 106 | 107 | `[]`里写链接文字,`()`里写链接地址, `()`中的 `""` 中可以为链接指定title属性, title属性可加可不加。title属性的效果是鼠标悬停在链接上会出现指定的 title文字。`[链接文字](链接地址 "链接标题")` 这样的形式。链接地址与链接标题前有一个空格。 108 | 109 | ```markdown 110 | [Markdown Syntax](https://github.com/cdoco/markdown-syntax) 111 | [Markdown Syntax](https://github.com/cdoco/markdown-syntax "Markdown Syntax") 112 | ``` 113 | 114 | > [Markdown Syntax](https://github.com/cdoco/markdown-syntax) 115 | >
116 | > 117 | > [Markdown Syntax](https://github.com/cdoco/markdown-syntax "Markdown Syntax") 118 | 119 | ### 参考式 120 | 121 | 参考式超链接一般用在学术论文上面, 或者另一种情况, 如果某一个链接在文章中多处使用, 那么使用引用的方式创建链接将非常好, 它可以让你对链接进行统一的管理。 122 | 123 | 参考式链接分为两部分, 文中的写法 `[链接文字][链接标记]`,在文本的任意位置添加 `[链接标记]:链接地址 "链接标题"`, 链接地址与链接标题前有一个空格。 124 | 125 | ```markdown 126 | 全球最大的搜索引擎网站是[Google][1]。 127 | 128 | [1]:http://www.google.com "Google" 129 | ``` 130 | 131 | > 全球最大的搜索引擎网站是 [Google][1]。 132 | >
133 | > 134 | > [1]:http://www.google.com "Google" 135 | 136 | ### 自动链接 137 | 138 | Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱, 只要是用 `<>` 包起来, Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样, 例如: 139 | 140 | ```markdown 141 | 142 | 143 | 144 | ``` 145 | 146 | > 147 | >
148 | > 149 | > 150 | 151 | ## 区块引用 152 | 153 | 区块引用需要在被引用的文本前加上 `>` 符号。 154 | 155 | ```markdown 156 | > 这是一个区块引用实例, 157 | 158 | > Markdown. 159 | ``` 160 | 161 | > 这是一个区块引用实例, 162 | 163 | > Markdown. 164 | 165 | Markdown 也允许你偷懒只在整个段落的第一行最前面加上 `>` : 166 | 167 | ```markdown 168 | > 平生不会相思, 169 | 才会相思, 170 | 便害相思。 171 | 172 | > 空一缕余香在此, 173 | 盼千金游子何之。 174 | ``` 175 | 176 | > 平生不会相思, 177 | 才会相思, 178 | 便害相思。 179 | 180 | > 空一缕余香在此, 181 | 盼千金游子何之。 182 | 183 | ### 引用的多层嵌套 184 | 185 | 区块引用可以嵌套(例如:引用内的引用), 只要根据层次加上不同数量的 `>` : 186 | 187 | ```markdown 188 | >>> 锄禾日当午, 汗滴禾下土。 - 李绅 189 | 190 | >> 山有木兮木有枝, 心悦君兮君不知。 - 越人歌 191 | 192 | > 去年今日此门中, 人面桃花相映红。 - 崔护 193 | ``` 194 | 195 | >>> 锄禾日当午, 汗滴禾下土。 - 李绅 196 | 197 | >> 山有木兮木有枝, 心悦君兮君不知。 - 越人歌 198 | 199 | > 去年今日此门中, 人面桃花相映红。 - 题都城南庄 200 | 201 | ### 引用其它要素 202 | 203 | 引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等: 204 | 205 | ```markdown 206 | > - 入我相思门, 知我相思苦。 207 | > 208 | > - 长相思兮长相忆, 短相思兮无穷极。 209 | > 210 | > - 给出一些例子代码: 211 | > ```markdown 212 | > return debug_backtrace(); 213 | > ``` 214 | ``` 215 | 216 | > - 入我相思门, 知我相思苦。 217 | > 218 | > - 长相思兮长相忆, 短相思兮无穷极。 219 | > 220 | > - 给出一些例子代码: 221 | > ```markdown 222 | > return debug_backtrace(); 223 | > ``` 224 | 225 | ## 锚点 226 | 227 | 网页中, 锚点其实就是页内超链接, 也就是链接本文档内部的某些元素, 实现当前页面中的跳转。比如我这里写下一个锚点, 点击回到目录, 就能跳转到目录。 在目录中点击这一节, 就能跳过来。还有下一节的注脚。这些根本上都是用锚点来实现的。 228 | 229 | ```markdown 230 | **[⬆ top](#什么是-markdown-)** 231 | ``` 232 | 233 | **[⬆ top](#什么是-markdown-)** 234 | 235 | ## 强调 236 | 237 | Markdown 使用星号`*`和底线`_`作为标记强调字词的符号。 238 | 239 | ### 斜体 240 | 241 | ```markdown 242 | *花自飘零水自流* 243 | ``` 244 | 245 | > *花自飘零水自流* 246 | 247 | ### 粗体 248 | 249 | ```markdown 250 | **花自飘零水自流** 251 | ``` 252 | 253 | > **花自飘零水自流** 254 | 255 | ### 删除线 256 | 257 | ```markdown 258 | ~~花自飘零水自流~~ 259 | ``` 260 | 261 | > ~~花自飘零水自流~~ 262 | 263 | ## 列表 264 | 265 | 使用 *,+,- 表示无序列表。 266 | 267 | ### 无序列表 268 | 269 | ```markdown 270 | - 白头吟 271 | - 击鼓 272 | - 断句 273 | ``` 274 | 275 | > - 白头吟 276 | > 277 | > - 击鼓 278 | > 279 | > - 断句 280 | 281 | ### 有序列表 282 | 283 | 有序列表则使用数字接着一个英文句点。 284 | 285 | ```markdown 286 | 1. 白头吟 287 | 2. 击鼓 288 | 3. 断句 289 | ``` 290 | 291 | > 1. 白头吟 292 | > 293 | > 2. 击鼓 294 | > 295 | > 3. 断句 296 | 297 | ### 包含引用的列表 298 | 299 | 如果要在列表项目内放进引用,那 `>` 就需要缩进: 300 | 301 | ```markdown 302 | * 菩提偈: 303 | 304 | > 菩提本无树,明镜亦非台。 305 | > 本来无一物,何处惹尘埃! 306 | ``` 307 | 308 | * 菩提偈: 309 | 310 | > 菩提本无树,明镜亦非台。 311 | > 本来无一物,何处惹尘埃! 312 | 313 | ## 插入图片 314 | 315 | 图片的创建方式与超链接相似, 而且和超链接一样也有两种写法, 行内式和参考式写法。 316 | 317 | 语法中图片Alt的意思是如果图片因为某些原因不能显示, 就用定义的图片Alt文字来代替图片。 图片Title则和链接中的Title一样, 表示鼠标悬停与图片上时出现的文字。 Alt 和 Title 都不是必须的, 可以省略, 但建议写上。 318 | 319 | ### 图片行内式 320 | 321 | `![图片Alt](图片地址 "图片Title")` 322 | 323 | ```markdown 324 | ![哆啦A梦](https://cdoco.com/images/duolaameng.jpeg "哆啦A梦") 325 | ``` 326 | 327 | ![哆啦A梦](https://cdoco.com/images/duolaameng.jpeg "哆啦A梦") 328 | 329 | ### 图片参考式 330 | 331 | 在文档要插入图片的地方写 `![图片Alt][标记]`。 332 | 333 | 在文档的最后写上 `[标记]:图片地址 "Title"`。 334 | 335 | ```markdown 336 | ![哆啦A梦][duolaameng] 337 | 338 | [duolaameng]:https://cdoco.com/images/duolaameng.jpeg "哆啦A梦" 339 | ``` 340 | 341 | ![哆啦A梦][duolaameng] 342 | 343 | [duolaameng]:https://cdoco.com/images/duolaameng.jpeg "哆啦A梦" 344 | 345 | ## 表格 346 | 347 | 1. 不管是哪种方式, 第一行为表头, 第二行分隔表头和主体部分, 第三行开始每一行为一个表格行。 348 | 2. 列于列之间用管道符`|`隔开。原生方式的表格每一行的两边也要有管道符。 349 | 3. 第二行还可以为不同的列指定对齐方向。默认为左对齐, 在`-`右边加上`:`就右对齐。 350 | 351 | 简单方式: 352 | 353 | ```markdown 354 | 诗名|作者|朝代 355 | -|-|- 356 | 白头吟|卓文君|两汉 357 | 锦瑟|李商隐|唐代 358 | 登科后|孟郊|唐代 359 | ``` 360 | 361 | 诗名|作者|朝代 362 | -|-|- 363 | 白头吟|卓文君|两汉 364 | 锦瑟|李商隐|唐代 365 | 登科后|孟郊|唐代 366 | 367 | 原生方式: 368 | 369 | ```markdown 370 | |诗名|作者|朝代| 371 | |-|-|-| 372 | |白头吟|卓文君|两汉| 373 | |锦瑟|李商隐|唐代| 374 | |登科后|孟郊|唐代| 375 | ``` 376 | 377 | |诗名|作者|朝代| 378 | |-|-|-| 379 | |白头吟|卓文君|两汉| 380 | |锦瑟|李商隐|唐代| 381 | |登科后|孟郊|唐代| 382 | 383 | 为表格第二列指定方向: 384 | 385 | ```markdown 386 | 诗名|名句 387 | -|-: 388 | 梦微之|君埋泉下泥销骨。 389 | 上邪|上邪,我欲与君相知,长命无绝衰。 390 | ``` 391 | 392 | 诗名|名句 393 | -|-: 394 | 梦微之|君埋泉下泥销骨。 395 | 上邪|上邪,我欲与君相知,长命无绝衰。 396 | 397 | ## 代码 398 | 399 | 对于程序员来说这个功能是必不可少的, 插入程序代码的方式有两种, 一种是利用缩进(Tab), 另一种是利用 "`" 符号(一般在ESC键下方)包裹代码。 400 | 401 | - 插入行内代码, 即插入一个单词或者一句代码的情况,使用 \`code\` 这样的形式插入。 402 | - 插入多行代码, 可以使用缩进或者 \`\`\` code \`\`\`, 具体看示例。 403 | 404 | ### 代码行内式 405 | 406 | ```markdown 407 | PHP打印堆栈信息 `debug_backtrace()`。 408 | ``` 409 | 410 | > PHP打印堆栈信息 `debug_backtrace()`。 411 | 412 | ### 缩进式多行代码 413 | 414 | 缩进 4 个空格或是 1 个制表符。 415 | 416 | 一个代码区块会一直持续到没有缩进的那一行(或是文件结尾)。 417 | 418 | ```markdown 419 | $closure = function () use($name) { 420 | return $name; 421 | } 422 | ``` 423 | 424 | $closure = function () use($name) { 425 | return $name; 426 | } 427 | 428 | ### 用六个 ` 包裹多行代码 429 | 430 | ```php 431 | ```php 432 | $closure = function () use($name) { 433 | return $name; 434 | } 435 | ` `` 436 | ``` 437 | 438 | ```php 439 | $closure = function () use($name) { 440 | return $name; 441 | } 442 | ``` 443 | 444 | ### HTML 原始码 445 | 446 | 在代码区块里面, `&` 、 `<` 和 `>` 会自动转成 HTML 实体, 这样的方式让你非常容易使用 Markdown 插入范例用的 HTML 原始码, 只需要复制贴上, 剩下的 Markdown 都会帮你处理,例如: 447 | 448 | ```html 449 | 450 | 451 | 452 | 453 | 454 | 455 | 456 | 457 | 458 | 459 | 460 | 461 |
值班人员星期一星期二星期三
李强张明王平
462 | ``` 463 | 464 | 465 | 466 | 467 | 468 | 469 | 470 | 471 | 472 | 473 | 474 | 475 | 476 |
值班人员星期一星期二星期三
李强张明王平
477 | 478 | ### 内容目录 479 | 480 | 在段落中填写 `[TOC]` 以显示全文内容的目录结构。 481 | 482 | ## 注脚 483 | 484 | 在需要添加注脚的文字后加上脚注名字`[^注脚名字]`, 称为加注。 然后在文本的任意位置(一般在最后)添加脚注, 脚注前必须有对应的脚注名字。 485 | 486 | ```markdown 487 | 使用 Markdown[^1]可以效率的书写文档, 直接转换成 HTML[^2]。 488 | 489 | [^1]: Markdown 是一种纯文本标记语言 490 | 491 | [^2]: HyperText Markup Language 超文本标记语言 492 | ``` 493 | 494 | PS: github 不支持注脚 :joy: 495 | 496 | ## LaTeX 公式 497 | 498 | ### $ 表示行内公式 499 | 500 | ```markdown 501 | 质能守恒方程可以用一个很简洁的方程式 $E=mc^2$ 来表达。 502 | ``` 503 | 504 | 质能守恒方程可以用一个很简洁的方程式 ![](https://latex.codecogs.com/gif.latex?E=mc^2) 来表达。 505 | 506 | ### $$ 表示整行公式 507 | 508 | ```markdown 509 | $$\sum_{i=1}^n a_i=0$$ 510 | $$f(x_1,x_x,\ldots,x_n) = x_1^2 + x_2^2 + \cdots + x_n^2 $$ 511 | $$\sum^{j-1}_{k=0}{\widehat{\gamma}_{kj} z_k}$$ 512 | ``` 513 | 514 | 过去 github 不支持 LaTeX 公式, 但是有个折中的解决方案, 使用 codecogs, 例如: 515 | 516 | ```markdown 517 | ![](https://latex.codecogs.com/gif.latex?\sum_{i=1}^n%20a_i=0) 518 | ![](https://latex.codecogs.com/gif.latex?f\(x_1,x_x,\ldots,x_n\)%20=%20x_1^2%20+%20x_2^2%20+%20\cdots%20+%20x_n^2%20) 519 | ``` 520 | 521 | ![](https://latex.codecogs.com/gif.latex?\sum_{i=1}^n%20a_i=0) 522 | 523 | ![](https://latex.codecogs.com/gif.latex?f\(x_1,x_x,\ldots,x_n\)%20=%20x_1^2%20+%20x_2^2%20+%20\cdots%20+%20x_n^2%20) 524 | 525 | 现在 github 已经支持 LaTeX 公式: 526 | 527 | $$\sum_{i=1}^n a_i=0$$ 528 | $$f(x_1,x_x,\ldots,x_n) = x_1^2 + x_2^2 + \cdots + x_n^2 $$ 529 | 530 | ## 流程图 531 | 532 | 流程图大致分为两段, 第一段是定义元素, 第二段是定义元素之间的走向。 533 | 534 | 定义元素的语法 `tag=>type: content:>url`。 535 | 536 | - tag就是元素名字。 537 | - type是这个元素的类型, 有6中类型,分别为: 538 | 539 | type|含义 540 | -|- 541 | start|开始 542 | end|结束 543 | operation|操作 544 | subroutine|子程序 545 | condition|条件 546 | inputoutput|输入或产出 547 | 548 | content 就是在框框中要写的内容, 注意type后的冒号与文本之间一定要有个空格。 549 | 550 | 用`->`来连接两个元素, 需要注意的是condition类型, 因为他有yes和no两个分支, 所以要写成: 551 | 552 | ```markdown 553 | c2(yes)->io->e 554 | c2(no)->op2->e 555 | ``` 556 | 557 | ```markdown 558 | ```flow 559 | st=>start: Start:>https://www.markdown-syntax.com 560 | io=>inputoutput: verification 561 | op=>operation: Your Operation 562 | cond=>condition: Yes or No? 563 | sub=>subroutine: Your Subroutine 564 | e=>end 565 | st->io->op->cond 566 | cond(yes)->e 567 | cond(no)->sub->io 568 | ` `` 569 | ``` 570 | 571 | ![](https://cdoco.com/images/flow.png) 572 | 573 | PS: github 不支持流程图 :joy: 574 | 575 | ## 时序图 576 | 577 | ```markdown 578 | ```sequence 579 | Alice->Bob: Hello Bob, how are you ? 580 | Note right of Bob: Bob thinks 581 | Bob-->Alice: I am good thanks! 582 | ` `` 583 | ``` 584 | 585 | ![](https://cdoco.com/images/sequence.png) 586 | 587 | PS: github 不支持时序图 :joy: 588 | 589 | ## 待办事宜列表 590 | 591 | 使用带有 `[ ]` 或 `[x]` (未完成或已完成)项的列表语法撰写一个待办事宜列表, 例如: 592 | 593 | ```markdown 594 | * [ ] 早起跑步 595 | * [x] 看书 596 | ``` 597 | 598 | * [ ] 早起跑步 599 | * [x] 看书 600 | 601 | **[⬆ top](#什么是-markdown-)** -------------------------------------------------------------------------------- /docs/.nojekyll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cdoco/markdown-syntax/9e479598623a785be8597dfc27ef979909e1b9b3/docs/.nojekyll -------------------------------------------------------------------------------- /docs/CNAME: -------------------------------------------------------------------------------- 1 | markdown-syntax.com -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | ![](https://cdoco.com/images/markdown-syntax.png) 2 | 3 | ## 什么是 Markdown ? 4 | 5 | > Markdown 是一种可以使用普通文本编辑器编写的标记语言, 通过简单的标记语法, 它可以使普通文本内容具有一定的格式。 6 | 7 | ## 分级标题 8 | 9 | 第一种写法: 10 | 11 | ```markdown 12 | 这是一个一级标题 13 | ============================ 14 | 15 | 这是一个二级标题 16 | -------------------------------------------------- 17 | ``` 18 | 19 | > 这是一个一级标题 20 | > ============================ 21 | > 这是一个二级标题 22 | > -------------------------------------------------- 23 | 24 | --- 25 | 26 | 第二种写法: 27 | 28 | ```markdown 29 | # 一级标题 30 | ## 二级标题 31 | ### 三级标题 32 | #### 四级标题 33 | ##### 五级标题 34 | ###### 六级标题 35 | ``` 36 | 37 | > # 一级标题 38 | > ## 二级标题 39 | > ### 三级标题 40 | > #### 四级标题 41 | > ##### 五级标题 42 | > ###### 六级标题 43 | 44 | ## 分隔线 45 | 46 | 你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线, 行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线: 47 | 48 | ``` markdown 49 | * * * 50 | 51 | *** 52 | 53 | ***** 54 | 55 | - - - 56 | 57 | --------------------------------------- 58 | ``` 59 | 60 | > * * * 61 | > - - - 62 | 63 | ## 超链接 64 | 65 | Markdown 支持两种形式的链接语法: 行内式和参考式两种形式, 行内式一般使用较多。 66 | 67 | ### 行内式 68 | 69 | `[]`里写链接文字,`()`里写链接地址, `()`中的 `""` 中可以为链接指定title属性, title属性可加可不加。title属性的效果是鼠标悬停在链接上会出现指定的 title文字。`[链接文字](链接地址 "链接标题")` 这样的形式。链接地址与链接标题前有一个空格。 70 | 71 | ```markdown 72 | [Markdown Syntax](https://github.com/cdoco/markdown-syntax) 73 | [Markdown Syntax](https://github.com/cdoco/markdown-syntax "Markdown Syntax") 74 | ``` 75 | 76 | > [Markdown Syntax](https://github.com/cdoco/markdown-syntax) 77 | >
78 | > 79 | > [Markdown Syntax](https://github.com/cdoco/markdown-syntax "Markdown Syntax") 80 | 81 | ### 参考式 82 | 83 | 参考式超链接一般用在学术论文上面, 或者另一种情况, 如果某一个链接在文章中多处使用, 那么使用引用的方式创建链接将非常好, 它可以让你对链接进行统一的管理。 84 | 85 | 参考式链接分为两部分, 文中的写法 `[链接文字][链接标记]`,在文本的任意位置添加 `[链接标记]:链接地址 "链接标题"`, 链接地址与链接标题前有一个空格。 86 | 87 | ```markdown 88 | 全球最大的搜索引擎网站是[Google][1]。 89 | 90 | [1]:http://www.google.com "Google" 91 | ``` 92 | 93 | > 全球最大的搜索引擎网站是 [Google][1]。 94 | >
95 | > 96 | > [1]:http://www.google.com "Google" 97 | 98 | ### 自动链接 99 | 100 | Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱, 只要是用 `<>` 包起来, Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样, 例如: 101 | 102 | ```markdown 103 | 104 | 105 | 106 | ``` 107 | 108 | > 109 | >
110 | > 111 | > 112 | 113 | ## 区块引用 114 | 115 | 区块引用需要在被引用的文本前加上 `>` 符号。 116 | 117 | ```markdown 118 | > 这是一个区块引用实例, 119 | 120 | > Markdown. 121 | ``` 122 | 123 | > 这是一个区块引用实例, 124 | 125 | > Markdown. 126 | 127 | Markdown 也允许你偷懒只在整个段落的第一行最前面加上 `>` : 128 | 129 | ```markdown 130 | > 平生不会相思, 131 | 才会相思, 132 | 便害相思。 133 | 134 | > 空一缕余香在此, 135 | 盼千金游子何之。 136 | ``` 137 | 138 | > 平生不会相思, 139 | 才会相思, 140 | 便害相思。 141 | 142 | > 空一缕余香在此, 143 | 盼千金游子何之。 144 | 145 | ### 引用的多层嵌套 146 | 147 | 区块引用可以嵌套(例如:引用内的引用), 只要根据层次加上不同数量的 `>` : 148 | 149 | ```markdown 150 | >>> 锄禾日当午, 汗滴禾下土。 - 李绅 151 | 152 | >> 山有木兮木有枝, 心悦君兮君不知。 - 越人歌 153 | 154 | > 去年今日此门中, 人面桃花相映红。 - 崔护 155 | ``` 156 | 157 | >>> 锄禾日当午, 汗滴禾下土。 - 李绅 158 | 159 | >> 山有木兮木有枝, 心悦君兮君不知。 - 越人歌 160 | 161 | > 去年今日此门中, 人面桃花相映红。 - 题都城南庄 162 | 163 | ### 引用其它要素 164 | 165 | 引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等: 166 | 167 | ```markdown 168 | > - 入我相思门, 知我相思苦。 169 | > 170 | > - 长相思兮长相忆, 短相思兮无穷极。 171 | > 172 | > - 给出一些例子代码: 173 | > ```markdown 174 | > return debug_backtrace(); 175 | > ``` 176 | ``` 177 | 178 | > - 入我相思门, 知我相思苦。 179 | > 180 | > - 长相思兮长相忆, 短相思兮无穷极。 181 | > 182 | > - 给出一些例子代码: 183 | > ```markdown 184 | > return debug_backtrace(); 185 | > ``` 186 | 187 | ## 锚点 188 | 189 | 网页中, 锚点其实就是页内超链接, 也就是链接本文档内部的某些元素, 实现当前页面中的跳转。比如我这里写下一个锚点, 点击回到目录, 就能跳转到目录。 在目录中点击这一节, 就能跳过来。还有下一节的注脚。这些根本上都是用锚点来实现的。 190 | 191 | ```markdown 192 | **[⬆ top](#什么是-markdown-)** 193 | ``` 194 | 195 | **[⬆ top](#什么是-markdown-)** 196 | 197 | ## 强调 198 | 199 | Markdown 使用星号`*`和底线`_`作为标记强调字词的符号。 200 | 201 | ### 斜体 202 | 203 | ```markdown 204 | *花自飘零水自流* 205 | ``` 206 | 207 | > *花自飘零水自流* 208 | 209 | ### 粗体 210 | 211 | ```markdown 212 | **花自飘零水自流** 213 | ``` 214 | 215 | > **花自飘零水自流** 216 | 217 | ### 删除线 218 | 219 | ```markdown 220 | ~~花自飘零水自流~~ 221 | ``` 222 | 223 | > ~~花自飘零水自流~~ 224 | 225 | ## 列表 226 | 227 | 使用 *,+,- 表示无序列表。 228 | 229 | ### 无序列表 230 | 231 | ```markdown 232 | - 白头吟 233 | - 击鼓 234 | - 断句 235 | ``` 236 | 237 | > - 白头吟 238 | > 239 | > - 击鼓 240 | > 241 | > - 断句 242 | 243 | ### 有序列表 244 | 245 | 有序列表则使用数字接着一个英文句点。 246 | 247 | ```markdown 248 | 1. 白头吟 249 | 2. 击鼓 250 | 3. 断句 251 | ``` 252 | 253 | > 1. 白头吟 254 | > 255 | > 2. 击鼓 256 | > 257 | > 3. 断句 258 | 259 | ### 包含引用的列表 260 | 261 | 如果要在列表项目内放进引用,那 `>` 就需要缩进: 262 | 263 | ```markdown 264 | * 菩提偈: 265 | 266 | > 菩提本无树,明镜亦非台。 267 | > 本来无一物,何处惹尘埃! 268 | ``` 269 | 270 | * 菩提偈: 271 | 272 | > 菩提本无树,明镜亦非台。 273 | > 本来无一物,何处惹尘埃! 274 | 275 | ## 插入图片 276 | 277 | 图片的创建方式与超链接相似, 而且和超链接一样也有两种写法, 行内式和参考式写法。 278 | 279 | 语法中图片Alt的意思是如果图片因为某些原因不能显示, 就用定义的图片Alt文字来代替图片。 图片Title则和链接中的Title一样, 表示鼠标悬停与图片上时出现的文字。 Alt 和 Title 都不是必须的, 可以省略, 但建议写上。 280 | 281 | ### 图片行内式 282 | 283 | `![图片Alt](图片地址 "图片Title")` 284 | 285 | ```markdown 286 | ![哆啦A梦](https://cdoco.com/images/duolaameng.jpeg "哆啦A梦") 287 | ``` 288 | 289 | ![哆啦A梦](https://cdoco.com/images/duolaameng.jpeg "哆啦A梦") 290 | 291 | ### 图片参考式 292 | 293 | 在文档要插入图片的地方写 `![图片Alt][标记]`。 294 | 295 | 在文档的最后写上 `[标记]:图片地址 "Title"`。 296 | 297 | ```markdown 298 | ![哆啦A梦][duolaameng] 299 | 300 | [duolaameng]:https://cdoco.com/images/duolaameng.jpeg "哆啦A梦" 301 | ``` 302 | 303 | ![哆啦A梦][duolaameng] 304 | 305 | [duolaameng]:https://cdoco.com/images/duolaameng.jpeg "哆啦A梦" 306 | 307 | ## 表格 308 | 309 | 1. 不管是哪种方式, 第一行为表头, 第二行分隔表头和主体部分, 第三行开始每一行为一个表格行。 310 | 2. 列于列之间用管道符`|`隔开。原生方式的表格每一行的两边也要有管道符。 311 | 3. 第二行还可以为不同的列指定对齐方向。默认为左对齐, 在`-`右边加上`:`就右对齐。 312 | 313 | 简单方式: 314 | 315 | ```markdown 316 | 诗名|作者|朝代 317 | -|-|- 318 | 白头吟|卓文君|两汉 319 | 锦瑟|李商隐|唐代 320 | 登科后|孟郊|唐代 321 | ``` 322 | 323 | 诗名|作者|朝代 324 | -|-|- 325 | 白头吟|卓文君|两汉 326 | 锦瑟|李商隐|唐代 327 | 登科后|孟郊|唐代 328 | 329 | 原生方式: 330 | 331 | ```markdown 332 | |诗名|作者|朝代| 333 | |-|-|-| 334 | |白头吟|卓文君|两汉| 335 | |锦瑟|李商隐|唐代| 336 | |登科后|孟郊|唐代| 337 | ``` 338 | 339 | |诗名|作者|朝代| 340 | |-|-|-| 341 | |白头吟|卓文君|两汉| 342 | |锦瑟|李商隐|唐代| 343 | |登科后|孟郊|唐代| 344 | 345 | 为表格第二列指定方向: 346 | 347 | ```markdown 348 | 诗名|名句 349 | -|-: 350 | 梦微之|君埋泉下泥销骨。 351 | 上邪|上邪,我欲与君相知,长命无绝衰。 352 | ``` 353 | 354 | 诗名|名句 355 | -|-: 356 | 梦微之|君埋泉下泥销骨。 357 | 上邪|上邪,我欲与君相知,长命无绝衰。 358 | 359 | ## 代码 360 | 361 | 对于程序员来说这个功能是必不可少的, 插入程序代码的方式有两种, 一种是利用缩进(Tab), 另一种是利用 "`" 符号(一般在ESC键下方)包裹代码。 362 | 363 | - 插入行内代码, 即插入一个单词或者一句代码的情况,使用 \`code\` 这样的形式插入。 364 | - 插入多行代码, 可以使用缩进或者 \`\`\` code \`\`\`, 具体看示例。 365 | 366 | ### 代码行内式 367 | 368 | ```markdown 369 | PHP打印堆栈信息 `debug_backtrace()`。 370 | ``` 371 | 372 | > PHP打印堆栈信息 `debug_backtrace()`。 373 | 374 | ### 缩进式多行代码 375 | 376 | 缩进 4 个空格或是 1 个制表符。 377 | 378 | 一个代码区块会一直持续到没有缩进的那一行(或是文件结尾)。 379 | 380 | ```markdown 381 | $closure = function () use($name) { 382 | return $name; 383 | } 384 | ``` 385 | 386 | $closure = function () use($name) { 387 | return $name; 388 | } 389 | 390 | ### 用六个 ` 包裹多行代码 391 | 392 | ```php 393 | ```php 394 | $closure = function () use($name) { 395 | return $name; 396 | } 397 | ` `` 398 | ``` 399 | 400 | ```php 401 | $closure = function () use($name) { 402 | return $name; 403 | } 404 | ``` 405 | 406 | ### HTML 原始码 407 | 408 | 在代码区块里面, `&` 、 `<` 和 `>` 会自动转成 HTML 实体, 这样的方式让你非常容易使用 Markdown 插入范例用的 HTML 原始码, 只需要复制贴上, 剩下的 Markdown 都会帮你处理,例如: 409 | 410 | ```html 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 |
值班人员星期一星期二星期三
李强张明王平
424 | ``` 425 | 426 | 427 | 428 | 429 | 430 | 431 | 432 | 433 | 434 | 435 | 436 | 437 | 438 |
值班人员星期一星期二星期三
李强张明王平
439 | 440 | ### 内容目录 441 | 442 | 在段落中填写 `[TOC]` 以显示全文内容的目录结构。 443 | 444 | ## 注脚 445 | 446 | 在需要添加注脚的文字后加上脚注名字`[^注脚名字]`, 称为加注。 然后在文本的任意位置(一般在最后)添加脚注, 脚注前必须有对应的脚注名字。 447 | 448 | ```markdown 449 | 使用 Markdown[^1]可以效率的书写文档, 直接转换成 HTML[^2]。 450 | 451 | [^1]: Markdown 是一种纯文本标记语言 452 | 453 | [^2]: HyperText Markup Language 超文本标记语言 454 | ``` 455 | 456 | PS: github 不支持注脚 :joy: 457 | 458 | ## LaTeX 公式 459 | 460 | ### $ 表示行内公式 461 | 462 | ```markdown 463 | 质能守恒方程可以用一个很简洁的方程式 $E=mc^2$ 来表达。 464 | ``` 465 | 466 | 质能守恒方程可以用一个很简洁的方程式 ![](https://latex.codecogs.com/gif.latex?E=mc^2) 来表达。 467 | 468 | ### $$ 表示整行公式 469 | 470 | ```markdown 471 | $$\sum_{i=1}^n a_i=0$$ 472 | $$f(x_1,x_x,\ldots,x_n) = x_1^2 + x_2^2 + \cdots + x_n^2 $$ 473 | $$\sum^{j-1}_{k=0}{\widehat{\gamma}_{kj} z_k}$$ 474 | ``` 475 | 476 | PS: github 不支持 LaTeX 公式, 但是有个折中的解决方案, 使用 codecogs, 例如: 477 | 478 | ```markdown 479 | ![](https://latex.codecogs.com/gif.latex?sum_{i=1}^n%20a_i=0) 480 | ![](https://latex.codecogs.com/gif.latex?f\(x_1,x_x,\ldots,x_n\)%20=%20x_1^2%20+%20x_2^2%20+%20\cdots%20+%20x_n^2%20) 481 | ``` 482 | 483 | ![](https://latex.codecogs.com/gif.latex?sum_{i=1}^n%20a_i=0) 484 | 485 | ![](https://latex.codecogs.com/gif.latex?f\(x_1,x_x,\ldots,x_n\)%20=%20x_1^2%20+%20x_2^2%20+%20\cdots%20+%20x_n^2%20) 486 | 487 | ## 流程图 488 | 489 | 流程图大致分为两段, 第一段是定义元素, 第二段是定义元素之间的走向。 490 | 491 | 定义元素的语法 `tag=>type: content:>url`。 492 | 493 | - tag就是元素名字。 494 | - type是这个元素的类型, 有6中类型,分别为: 495 | 496 | type|含义 497 | -|- 498 | start|开始 499 | end|结束 500 | operation|操作 501 | subroutine|子程序 502 | condition|条件 503 | inputoutput|输入或产出 504 | 505 | content 就是在框框中要写的内容, 注意type后的冒号与文本之间一定要有个空格。 506 | 507 | 用`->`来连接两个元素, 需要注意的是condition类型, 因为他有yes和no两个分支, 所以要写成: 508 | 509 | ```markdown 510 | c2(yes)->io->e 511 | c2(no)->op2->e 512 | ``` 513 | 514 | ```markdown 515 | ```flow 516 | st=>start: Start:>https://www.markdown-syntax.com 517 | io=>inputoutput: verification 518 | op=>operation: Your Operation 519 | cond=>condition: Yes or No? 520 | sub=>subroutine: Your Subroutine 521 | e=>end 522 | st->io->op->cond 523 | cond(yes)->e 524 | cond(no)->sub->io 525 | ` `` 526 | ``` 527 | 528 | ![](https://cdoco.com/images/flow.png) 529 | 530 | PS: github 不支持流程图 :joy: 531 | 532 | ## 时序图 533 | 534 | ```markdown 535 | ```sequence 536 | Alice->Bob: Hello Bob, how are you ? 537 | Note right of Bob: Bob thinks 538 | Bob-->Alice: I am good thanks! 539 | ` `` 540 | ``` 541 | 542 | ![](https://cdoco.com/images/sequence.png) 543 | 544 | PS: github 不支持时序图 :joy: 545 | 546 | ## 待办事宜列表 547 | 548 | 使用带有 `[ ]` 或 `[x]` (未完成或已完成)项的列表语法撰写一个待办事宜列表, 例如: 549 | 550 | ```markdown 551 | * [ ] 早起跑步 552 | * [x] 看书 553 | ``` 554 | 555 | * [ ] 早起跑步 556 | * [x] 看书 557 | 558 | **[⬆ top](#什么是-markdown-)** -------------------------------------------------------------------------------- /docs/_coverpage.md: -------------------------------------------------------------------------------- 1 | # Markdown Syntax 2 | 3 | * 带你快速了解 markdown 语法 4 | 5 | [GitHub](https://github.com/cdoco/markdown-syntax) 6 | [Get Started](#什么是-markdown-) -------------------------------------------------------------------------------- /docs/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Markdown Syntax 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 |
15 | 21 | 22 | 23 | 24 | --------------------------------------------------------------------------------