zhenhu / markdown (public) (License: Unspecified) (since 2019-03-05) (hash sha1)
A guide / introduce to markdown / markdown 指南 / markdown 语法
List of commits:
Subject Hash Author Date (UTC)
modified: README.md 6563d0beba24cc2ac4db758cb04092b33ae55500 zhenhu 2019-05-05 14:54:52
Update README.md 1bd385a412916eeef1e21271c1a6368cf30da1d0 Zhenhu 2019-04-09 03:26:58
Create LICENSE 5168049abe6780772e201ebdee6eb7b3cb9cdea1 Zhenhu 2019-04-09 03:23:20
fix the example of alternative headings' rendering efe1421429136d49bbfa6e9661b55669a90b67d5 zhenhu 2019-03-08 09:32:28
adjust the description of the overview 34c7745f5936203ffebc64d9620a55bc76ce82e5 zhenhu 2019-03-08 09:08:42
fix the example of headings 5ccd0ce886e5344655976ad102a3e98bdc812b12 zhenhu 2019-03-08 08:52:06
add alternative formats of headings 484067389f2e248d7d9fc2c7e43c21be0c2f70a7 zhenhu 2019-03-08 08:31:33
adjust the size of pic manalone.jpg 0f9edda5479625af6d0465911d98f8381abffc4c zhenhu 2019-03-07 08:54:46
add a pic freesolo.jpg 56fa6844e0db507b405ce7ad029edd32570bf6ee zhenhu 2019-03-06 17:59:32
fix content of images, add content of linking images 811ae2b07732ca1b7b0186ebe30a4ef423f2ea58 zhenhu 2019-03-06 16:32:46
Set theme jekyll-theme-minimal ce103219600c3f83a3d33ae533fb5ba4fd8d7c29 Zhenhu 2019-03-05 12:06:33
init markdown tutorial e10f3ee802232d0a2d3944310414d0ca3c0f9213 zhenhu 2019-03-05 12:01:08
Commit 6563d0beba24cc2ac4db758cb04092b33ae55500 - modified: README.md
Author: zhenhu
Author date (UTC): 2019-05-05 14:54
Committer name: zhenhu
Committer date (UTC): 2019-05-05 14:54
Parent(s): 1bd385a412916eeef1e21271c1a6368cf30da1d0
Signing key:
Tree: d0e43cce7baeb989db982f02dd768a3c43d4fd42
File Lines added Lines deleted
README.md 47 41
File README.md changed (mode: 100644) (index ba02c3b..2e4214a)
... ... Markdown 是一种轻量级标记语言,创于2004年,关键人物:[John G
68 68
69 69 #### 1.1 标题 (Headings) #### 1.1 标题 (Headings)
70 70
71 使用字符井号 ‘#’,空格,然后紧接标题名称来设置标题。支持六个级别的标题,字符 ‘#’ 的数量表示相应级别的标题。一级标题还可以在标题名称紧接着的下一行使用 N 个符号 ‘=’ 来替代井号,二级标题同样可以用 N 个符号 ‘-’ 来替代井号。
71 使用字符井号 ‘#’,空格,然后紧接标题名称来设置标题。支持六个级别的标题,字符 ‘#’ 的数量表示相应级别的标题。
72
73 一级标题还可以在标题名称紧接着的下一行使用 N 个符号 ‘=’ 来替代井号,二级标题同样可以用 N 个符号 ‘-’ 来替代井号。
72 74
73 75 示例: 示例:
74 76
 
... ... f. **斜体加删除线** (Italic and Strikethrough)
188 190
189 191 #### 1.5 水平线 (Horizontal Rules) #### 1.5 水平线 (Horizontal Rules)
190 192
191 使用三个或者三个以上字符 ‘-’ ,‘*’ 或 ‘_’ 都可以创建水平线。
193 使用三个及以上字符 ‘-’ ,‘*’ 或 ‘_’ 都可以创建水平线。
192 194
193 195 示例: 示例:
194 196
 
... ... f. **斜体加删除线** (Italic and Strikethrough)
206 208
207 209 #### 1.6 块引用 (Blockquotes) #### 1.6 块引用 (Blockquotes)
208 210
209 在文字段落前加符号 ‘>’ 表示块引用。块引用可以嵌套,标示符号数量代表其嵌套层级。
211 在文字行或段落前加符号 ‘>’ 表示块引用。块引用可以嵌套,标示符号数量代表其嵌套层级。
210 212
211 213 示例: 示例:
212 214
213 >这是引用的内容
215 >这是引用的内容
216 来个两行
214 217 >>这是嵌套引用的内容 >>这是嵌套引用的内容
215 218 >>>***这是另一个嵌套引用的内容*** >>>***这是另一个嵌套引用的内容***
216 >>>>>>## 这是最深层嵌套引用的内容
219 >>>>>>~~**这是最深层嵌套引用的内容**~~
217 220
218 221 渲染效果如下: 渲染效果如下:
219 222
220 >这是引用的内容
223 >这是引用的内容
224 来个两行
221 225 >>这是嵌套引用的内容 >>这是嵌套引用的内容
222 226 >>>***这是另一个嵌套引用的内容*** >>>***这是另一个嵌套引用的内容***
223 >>>>>>## 这是最深层嵌套引用的内容
227 >>>>>>~~**这是最深层嵌套引用的内容**~~
224 228
225 229 __注:__ _块引用可以结合多种其它元素使用。_ __注:__ _块引用可以结合多种其它元素使用。_
226 230
 
... ... __注:__ _块引用可以结合多种其它元素使用。_
232 236
233 237 a. **有序列表** (Ordered Lists) a. **有序列表** (Ordered Lists)
234 238
235 在列表条目前使用数字和符号 ‘.’ 表示有序列表 ,列表条目和点之间要有空格。
239 在列表条目前使用数字和符号 ‘.’ 表示有序列表 ,符号 ‘.’ 和列表条目之间要有空格。
236 240
237 241 1. 列表内容 1. 列表内容
238 242 2. 列表内容 2. 列表内容
 
... ... b. **无序列表** (Unordered lists)
262 266
263 267 c. **列表嵌套** (Nested Lists) c. **列表嵌套** (Nested Lists)
264 268
265 TAB缩进或4个空格都起到嵌套作用。
269 TAB 缩进或 4 个空格都起到嵌套作用。
266 270
267 271 1. 一级有序列表内容 1. 一级有序列表内容
268 272 - 二级无序列表内容 - 二级无序列表内容
 
... ... TAB缩进或4个空格都起到嵌套作用。
277 281 2. 二级有序列表内容 2. 二级有序列表内容
278 282 >这里是块引用。 >这里是块引用。
279 283
280 **注**: *在有些编辑器中TAB健已被设置为代表4个空格输出。*
284 **注**: *在有些编辑器中 TAB 健已被设置为代表 4 个空格输出。*
281 285
282 286 渲染效果如下: 渲染效果如下:
283 287
 
... ... TAB缩进或4个空格都起到嵌套作用。
304 308
305 309 a. **行内样式链接** (Inline-style Links) a. **行内样式链接** (Inline-style Links)
306 310
307 [超链接名](超链接地址 "超链接标题title")
311 [超链接名](超链接地址 "超链接标题 title")
308 312
309 313 示例: 示例:
310 314
311 315 [此处为行内样式链接](https://bing.com) [此处为行内样式链接](https://bing.com)
312 316
313 [此处为具有标题title的行内样式链接](http://google.com "权利与傲慢")
317 [此处为具有标题 title 的行内样式链接](http://google.com "权利与傲慢")
314 318
315 319 渲染效果如下: 渲染效果如下:
316 320
317 321 [此处为行内样式链接](https://bing.com) [此处为行内样式链接](https://bing.com)
318 322
319 [此处为具有title的行内样式链接](https://google.com "权利与傲慢")
323 [此处为具有标题 title 的行内样式链接](https://google.com "权利与傲慢")
320 324
321 325 b. **引用样式链接** (Reference-style Links) b. **引用样式链接** (Reference-style Links)
322 326
 
... ... b. **引用样式链接** (Reference-style Links)
324 328
325 329 `引用文本块:[超链接名][引用目标]` `引用文本块:[超链接名][引用目标]`
326 330
327 `被引用文本块:[被引用目标]: </超链接地址>/ "/'/(超链接title)/'/"`
331 `被引用文本块:[被引用目标]: </超链接地址/> "/'/(超链接 title)/'/"`
332
333 **注**: *被引用文本块可以单行放在文档任何位置。如果 `[超链接名]` 与 `[被引用目标]` 文本块内容相同,引用文本块的 `[引用目标]` 就可以省略,否则 `[引用目标]`和 `[被引用目标]` 的文本内容必须相同。*
328 334
329 **注**: *被引用文本块可以放在文档任何位置。如果超链接名与被引用目标文本内容相同,引用目标的括号及符号内的引用目标文本内容就可以省略,否则引用目标和被引用目标的文本内容必须相同。用来围住超链接的符号 ‘<>’ 可以省略。地址超链接标题titile可以用符号 ‘"’ , ‘'’ 或 ‘()’ 围起来。*
335 *用来围住超链接的符号 ‘<>’ 可以省略。`超链接标题 titile` 可以用符号 ‘"’ , ‘'’ 或 ‘()’ 围起来。*
330 336
331 337 示例: 示例:
332 338
333 [此处为引用样式链接][任意非大小写敏感文本或数字]
339 [此处为引用样式链接][任意不区分大小写文本或数字]
334 340
335 [任意非大小写敏感文本或数字]: https://www.facebook.com '面子的成本'
341 [任意不区分大小写文本或数字]: https://www.facebook.com '面子的成本'
336 342
337 343 [我和引用目标同名] [我和引用目标同名]
338 344
 
... ... b. **引用样式链接** (Reference-style Links)
340 346
341 347 渲染效果如下: 渲染效果如下:
342 348
343 [此处为引用样式链接][任意非大小写敏感文本]
349 [此处为引用样式链接][任意不区分大小写文本或数字]
344 350
345 [任意非大小写敏感文本]: https://www.facebook.com '面子的成本'
351 [任意不区分大小写文本或数字]: https://www.facebook.com '面子的成本'
346 352
347 353 [我和引用目标同名] [我和引用目标同名]
348 354
 
... ... d. **锚点** (Anchors)
372 378
373 379 锚点,也叫命名锚记,是页面内的定位器,通过链接访问可以直接跳转到页面的锚点部位。 锚点,也叫命名锚记,是页面内的定位器,通过链接访问可以直接跳转到页面的锚点部位。
374 380
375 在markdown中标题可以直接作为锚点,其它处可用html标记来生成锚点。
381 在 markdown 中标题可以直接作为锚点,其它处可用 html 标记来生成锚点。
376 382
377 383 html锚点: html锚点:
378 384
379 385 <a name="anchor1">你在找我吗?</a> <a name="anchor1">你在找我吗?</a>
380 或任何其它具有id的html标签,如:
386 或任何其它具有 id 的 html 标签,如:
381 387 <div id="anchor2">你还在找我吗?</div> <div id="anchor2">你还在找我吗?</div>
382 388 <a id="anchor3">你真的在找我吗?</a> <a id="anchor3">你真的在找我吗?</a>
383 389
 
... ... html锚点:
387 393
388 394 <a name="anchor1">你在找我吗?</a> <a name="anchor1">你在找我吗?</a>
389 395
390 或任何其它具有id的html标签,如:
396 或任何其它具有 id 的 html 标签,如:
391 397 <div id="anchor2">你还在找我吗?</div> <div id="anchor2">你还在找我吗?</div>
392 398 <a id="anchor3">你真的在找我吗?</a> <a id="anchor3">你真的在找我吗?</a>
393 399
 
... ... html锚点:
396 402
397 403 [超链接名称](#锚点) [超链接名称](#锚点)
398 404
399 **注**:*当标题作为锚点在引用时,锚点内容中大写字母要转为小写;中文不变;半角标点符号要直接去掉(虽然在有的 markdwon 中可以不去掉也有效);全角标点符号各 markdown 中解析有差异,不建议使用;空白字符要替换为符号 ‘-’ 。*
405 **注**:*当标题作为锚点在引用时,锚点内容中大写字母要转为小写;中文不变;半角标点符号要直接去掉(虽然在某些平台的 markdwon 中可以不去掉也有效);全角标点符号各平台 markdown 中解析有差异,不建议使用;空白字符要替换为符号 ‘-’ 。*
400 406
401 407 示例: 示例:
402 408
 
... ... html锚点:
420 426
421 427 a. **行内样式图片** (Inline-style Images) a. **行内样式图片** (Inline-style Images)
422 428
423 ![图片alt](图片地址 "图片title")
429 ![图片 alt](图片地址 "图片 title")
424 430
425 图片alt就是当图片无法显示时的替代文字。
426 图片title是图片的标题,当鼠标移到图片上时显示的内容。
427 title非必需。
431 `图片 alt` 是当图片无法显示时的替代文字。
432 `图片 title` 是图片的标题,当鼠标移到图片上时显示的文字内容。
433 `图片 title` 非必需。
428 434
429 435 b. **引用样式图片** (Reference-style Images) b. **引用样式图片** (Reference-style Images)
430 436
431 ![图片alt][引用目标]
437 ![图片 alt][引用目标]
432 438
433 [被引用目标] </图片地址>/ "/'/(图片title)/'/"
439 [被引用目标] </图片地址>/ "/'/(图片 title)/'/"
434 440
435 **注**: *引用样式图片与引用样式链接类似,引用块前有个符号 ‘!’,被引用块多了个符号‘"’。*
441 **注**: *引用样式图片与引用样式链接类似,引用块前有个符号 ‘!’。*
436 442
437 443 示例: 示例:
438 444
 
... ... b. **引用样式图片** (Reference-style Images)
452 458
453 459 c. **图片链接** (Linking Images) c. **图片链接** (Linking Images)
454 460
455 [![图片alt](图片地址 "图片title")](图片链接地址 "链接title")
461 [![图片 alt](图片地址 "图片 title")](图片链接地址 "链接 title")
456 462
457 463 **注:** *链接语法嵌套图片语法。* **注:** *链接语法嵌套图片语法。*
458 464
 
... ... a. **行内代码** (Inline-style Codes)
489 495
490 496 b. **代码块** (Code blocks) b. **代码块** (Code blocks)
491 497
492 在每行代码行前使用TAB缩进或4个空格。如果在列表中就必须使用两个TAB缩进或8个空格。
498 在每行代码行前使用 TAB 缩进或 4 个空格。如果在列表中就必须使用两个 TAB 缩进或 8 个空格。
493 499
494 500 渲染效果如下: 渲染效果如下:
495 501
 
... ... b. **代码块** (Code blocks)
526 532 | 字符 | 名称 | 英文对照 | | 字符 | 名称 | 英文对照 |
527 533 | ---- | ------ | ------------------- | | ---- | ------ | ------------------- |
528 534 | \ | 反斜线 | backslash | | \ | 反斜线 | backslash |
529 | ` | 反引号 | tick mark |
535 | ` | 反引号 | backtick (back quote) |
530 536 | * | 星号 | asterisk | | * | 星号 | asterisk |
531 537 | _ | 下划线 | underscore | | _ | 下划线 | underscore |
532 538 | {} | 大括号 | curly braces | | {} | 大括号 | curly braces |
533 539 | [] | 中括号 | brackets | | [] | 中括号 | brackets |
534 540 | () | 括号 | parentheses | | () | 括号 | parentheses |
535 | # | 井号 | pound sign |
541 | # | 井号 | pound sign (hash) |
536 542 | + | 加号 | plus sign | | + | 加号 | plus sign |
537 543 | - | 减号 | minus sign (hyphen) | | - | 减号 | minus sign (hyphen) |
538 544 | . | 点 | dot | | . | 点 | dot |
539 545 | ! | 感叹号 | exclamation mark | | ! | 感叹号 | exclamation mark |
540 546 | \| | 管道 | pipe | | \| | 管道 | pipe |
541 547
542 **注**: *为了在表单中显示管道,对其进行转义* `\|`*,也可以直接使用其HTML代码 `&#124;`,也可以达到同样效果。*
548 **注**: *为了在表单中显示管道,对其进行转义* `\|`*,也可以直接使用其 HTML代码 `&#124;`,也可以达到同样效果。*
543 549
544 550 [回到目录](#目录-table-of-contents) [回到目录](#目录-table-of-contents)
545 551
 
... ... b. **代码块** (Code blocks)
565 571
566 572 Markdown 综合属性 Markdown 综合属性
567 573
568 | 特点 | 应用的网络平台 | 编辑器 | 关联软件及语言 |
569 | ---- | -------------- | ------------ | -------------- |
570 | 轻量 | github | VScode | Git |
571 | 简单 | WordPress | Atom | Pandoc |
572 | 易学 | Stack Overflow | Markdown pad | HTML |
574 | 特点 | 应用的网络平台 | 编辑器 | 关联软件及语言 |
575 | ---- | ---------------- | ------------- | -------------- |
576 | 轻量 | [Github] | [VScode] | [Git] |
577 | 简单 | [WordPress] | [Atom] | [Pandoc] |
578 | 易学 | [Stack Overflow] | [MarkdownPad] | [HTML] |
573 579
574 580 [Github]: https://github.com/ [Github]: https://github.com/
575 581 [WordPress]: https://wordpress.com/ [WordPress]: https://wordpress.com/
 
... ... Markdown 综合属性
588 594 | 特点 | 应用的网络平台 | 编辑器 | 关联软件及语言 | | 特点 | 应用的网络平台 | 编辑器 | 关联软件及语言 |
589 595 | ---- | ---------------- | ------------- | -------------- | | ---- | ---------------- | ------------- | -------------- |
590 596 | 轻量 | [Github] | [VScode] | [Git] | | 轻量 | [Github] | [VScode] | [Git] |
591 | 简单 | [WordPress] | [Atom] | [Pandoc] |
597 | 简单 | [WordPress] | [Atom] | [Pandoc] |
592 598 | 易学 | [Stack Overflow] | [MarkdownPad] | [HTML] | | 易学 | [Stack Overflow] | [MarkdownPad] | [HTML] |
593 599
594 600 [Github]: https://github.com/ [Github]: https://github.com/
Hints:
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://rocketgit.com/user/zhenhu/markdown

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@ssh.rocketgit.com/user/zhenhu/markdown

Clone this repository using git:
git clone git://git.rocketgit.com/user/zhenhu/markdown

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a merge request:
... clone the repository ...
... make some changes and some commits ...
git push origin main