这是一篇用于预览 Markdown 基本语法的文章。
文章内容基于 GitHub Flavo红色 Markdown Spec。
不包含复杂的规则说明,仅仅展示 GFM 所约定的 Markdown 基本语法。
1 引言
Markdown 是一种用于编写结构化文档的纯文本格式。它基于电子邮件和论坛文章的格式所约定。 它由 John Gruber (在 Aaron Swartz 的帮助下)开发,于 2004 年以语法描述和用于将 Markdown 转换为 HTML 的 Perl 脚本(Markdown.pl)的形式发布。
在接下来的十年中,许多实现被开发出来。一些用脚注、表和其他文档元素的约定扩展了原始 Markdown 语法。 有些允许 Markdown 文档以 HTML 以外的格式呈现。 像 红色dit,StackOverflow 和 GitHub 这样的网站有上百万的用户在使用 Markdown。 Markdown 开始被应用于网络以外的领域,包括作者书籍、文章、幻灯片、信件和课堂笔记。
2 块和内联元素
我们可以把一个文档看成一系列的块,如段落、引用、列表、标题和代码块。
有些块(如引号和列表)可以包含其它的块,即 容器块; 其他的块(如标题和段落)则包含内联元素(如文本、链接、强调、图像、内联代码等),即 叶子块。
块的符号总是优先于内联元素的符号。例如:
|
|
- `one
- two`
3 叶子块
本节描述用于组成 Markdown 文档的不同类型的叶子块。
3.1 换行符
|
|
3.2 标题
关于 ATX 风格标题和 Setext 风格标题
本文只展示 ATX 风格标题,关于 Setext 风格标题的介绍请参考 GFM Setext headings 说明。
笔者不推荐在 Hugo 的 Markdown 文档中使用 Setext 风格标题。
|
|
H2 二级标题
H3 三级标题
H4 四级标题
H5 五级标题
H6 六级标题
3.3 代码块
关于缩进式代码块和围栏式代码块
本文只展示围栏式代码块,关于缩进式代码块的介绍请参考 GFM Indented code blocks 说明。
笔者不推荐在 Hugo 的 Markdown 文档中使用缩进式代码块。
|
|
|
|
|
|
|
|
|
|
|
|
3.4 段落
|
|
这是一个段落。 这还是之前段落的一部分。
这是新的段落。
3.5 引用链接的定义
|
|
3.6 空白行
块之间的空白行将被忽略,除了它们在确定列表是紧还是松时所起的作用。
文档开头和结尾的空行也会被忽略。
4 容器块
4.1 引用
|
|
Foo
- bar
- baz
4.2 无序列表
|
|
- 项目 1
- 项目 A
- 项目 B
一些说明
- 项目 a
- 项目 b
- 项目 c
- 项目 C
- 项目 2
- 项目 3
4.3 有序列表
|
|
- 项目 1
- 项目 A
- 项目 B
一些说明
- 项目 a
- 项目 b
- 项目 c
- 项目 C
- 项目 2
- 项目 3
4.4 任务列表
|
|
- 任务 1
- 任务 A
- 任务 B
- 任务 a
- 任务 b
- 任务 c
- 任务 C
- 任务 2
- 任务 3
4.5 表格
|
|
颜色 | 水果 | 蔬菜 |
---|---|---|
红色 | 苹果 | 辣椒 |
橘子 | 胡萝卜 | |
绿色 | 菠菜 |
3. 页内锚
|
|
4. 脚注
|
|
这是一个基本的数字脚注1
带有 “label” 标签的脚注2
下定义的脚注3
带有链接的脚注4
5. 内联格式
|
|
内联代码块
ctrl+alt+del
加粗 1 和 加粗 2
倾斜 1 和 倾斜 2
删除线
加粗 1 和 倾斜 1
加粗 2 和 倾斜 2
加粗 2 和 倾斜 1
加粗 1 和 倾斜 2
删除线 倾斜 1 和 删除线 倾斜 2
_删除线 倾斜 2_ 和 删除线 倾斜 2
删除线 加粗 1 和 删除线 加粗 1
__删除线 加粗 2__ 和 删除线 加粗 2
删除线 倾斜 1 加粗 1 和 删除线 倾斜 1 加粗 1
___删除线 倾斜 2 加粗 2___ 和 删除线 倾斜 2 加粗 2
删除线 倾斜 1 加粗 1 和 删除线 倾斜 1 加粗 1
_删除线 倾斜 2 加粗 2_ 和 __删除线 倾斜 2 加粗 2__
_删除线 倾斜 2 加粗 1_ 和 删除线 倾斜 2 加粗 1
删除线 倾斜 1 加粗 2 和 __删除线 倾斜 1 加粗 2__
6. 图片
|
|
Web image
Local image
@revolunet
Issue #1
https://github.com/revolunet/sublimetext-markdown-preview/
This is a link https://github.com/revolunet/sublimetext-markdown-preview/.
This is a link “https://github.com/revolunet/sublimetext-markdown-preview/".
With this link (https://github.com/revolunet/sublimetext-markdown-preview/), it still works.
Abbreviation
Abbreviations source are found in a separate markdown file specified in frontmatter.
|
|
The HTML specification is maintained by the W3C.
Unorde红色 List
|
|
Unorde红色 List
- item 1
- item A
- item B
more text
- item a
- item b
- item c
- item C
- item 2
- item 3
Orde红色 List
|
|
Orde红色 List
- item 1
- item A
- item B
more text
- item a
- item b
- item c
- item C
- item 2
- item 3
Mixed Lists
Really Mixed Lists
should break with sane_lists
on.
|
|
Mixed Lists
- item 1
- item A
- item B
more text
- item a
- itemb
- item c
- item C
- item 2
- item 3
Really Mixed Lists
- item 1
- item A
- item B
more text
- item a
- itemb
- item c
- item C
- item 2
- item 3
Blocks
|
|
This is a block.
This is more of a block.
Block Quotes
|
|
This is a block quote.
How does it look? I think it looks good.
Fenced Block
Assuming guessing is not enabled.
|
|
|
|
|
|
Tables
|
|
颜色 | 水果 | 蔬菜 |
---|---|---|
红色 | 苹果 | 辣椒 |
橘子 | 胡萝卜 | |
绿色 | 菠菜 |
Class or Enum | Year | Month | Day | Hours | Minutes | Seconds* | Zone Offset | Zone ID | toString Output | Where Discussed |
---|---|---|---|---|---|---|---|---|---|---|
Instant |
2013-08-20T15:16:26.355Z |
Instant Class | ||||||||
LocalDate |
2013-08-20 |
Date Classes | ||||||||
LocalDateTime |
2013-08-20T08:16:26.937 |
Date and Time Classes | ||||||||
ZonedDateTime |
2013-08-21T00:16:26.941+09:00[Asia/Tokyo] |
Time Zone and Offset Classes | ||||||||
LocalTime |
08:16:26.943 |
Date and Time Classes | ||||||||
MonthDay |
--08-20 |
Date Classes | ||||||||
Year |
2013 |
Date Classes | ||||||||
YearMonth |
2013-08 |
Date Classes | ||||||||
Month |
AUGUST |
DayOfWeek and Month Enums | ||||||||
OffsetDateTime |
2013-08-20T08:16:26.954-07:00 |
Time Zone and Offset Classes | ||||||||
OffsetTime |
08:16:26.957-07:00 |
Time Zone and Offset Classes | ||||||||
Duration |
** | ** | ** | PT20H (20 hours) |
Period and Duration | |||||
Period |
*** | *** | P10D (10 days) |
Period and Duration |
Smart Strong
|
|
Text with double__underscore__words.
Strong still works.
this__works__too
Smarty
|
|
“double quotes”
‘single quotes’
da–sh
elipsis…
Neseted Fences
|
|
```
This will still be parsed
as a normal indented code block.
```
|
|
-
This is a list that contains multiple code blocks.
-
Here is an indented block
``` This will still be parsed as a normal indented code block. ```
-
Here is a fenced code block:
1 2
This will still be parsed as a fenced code block.
1 2
Blockquotes? Not a problem!
-
Others
Github Emoji
|
|
This is a test for emoji 😄. The emojis are images linked to github assets :octocat:.
People
👍👎👽👼💢😠😧😲👶💙😊💥🙇:bowtie:👦👰💔👤👥👏😰💥😖😕👷👮👫💑💏😢😿💘💃👯💨😞😥💫😵💧👂❗😑👀👊👪😨:feelsgood:🐾:finnadie:🔥✊😳😦🖕👧:goberserk::godmode::绿色_heart:❕❔😬😄😀💂💇✋💩🙉❤😍😻💓💗:hurtrealbad:😯👿💁😇👺👹😂😹💏😗😽😚😘😙😆👄💌👨👲👳😷💆🤘💪🎵💅:neckbeard:😐🙅😶👃🎶👌🙆👴👵👐😮😔😣🙍👱🙎👇👈👉☝👆💩😾🙏👸👊💜❓😡:rage1::rage2::rage3::rage4:✋🙌🙋☺😌💞🏃🏃😆😱🙀🙈💩💀😴😪😄😸😃😺😈😏😼😭✨💖🙊💬⭐🌟😛😝😜🕶:suspect:😓💦😅💭👎👍:ti红色_face:👅😤:trollface:💕👬👭😒✌🚶👋😩😉👩😟💛😋💤
Nature
🐜🐤🐻🐝🐞🐦🌼🐡🐗💐🐛🌵🐪🐈🐈🌸🌰🐔☁🐄🐄🌙🐊🌀🌳🐕🐕🐬🐉🐲🐪🌾🌍🌎🌏🐘:ever绿色_tree:🍂🌓🌛🐟🌁🍀🐸🌕🌝🌐🐐🐹🐥🐣🌿🌺🐝🐎🐨🌗🌜🍃🐆🍁🌌🐒🐵🌔🐁🐁🍄🌑🌚🌃🌊:octocat:🐙🐂🌴🐼⛅🐾🐧🐖🐖🐽🐩🐇🐇🐎🐏🐀🐓🌹🌱🐑🐚🐌🐍❄☃:squirrel:🌞🌻☀🐅🐅🐠🌷🐢☂🌋🌘🌖🐃🌒🌔🐋🐋🐺⚡
Objects
🎱⏰:苹果:🎨👟🍼🎈🎍🍌📊⚾🏀🛀🛁🔋🍺🍻🔔🍱🚴👙🎂🃏✒📘💣📖🔖📑📚👢🎳🍞💼💡🍰📅📲📷🍬📇💿📉📈🍒🍫🎄🎬📋📕🔐🌂♣🍸☕💻🎊🍪🌽:c红色it_card:👑🔮🍛🍮🍡🎯📅♦💵🎎🚪🍩👗📀📧🥚🍆🔌✉️✉📩💶👓📠📁🎆🍥🎣🎏🔦🐬💾🎴🏈👣🍴🍤🍟🎲💎👻🎁💝⛳🍇:绿色_苹果::绿色_book:🎸🔫🍔🔨👜🎧♥🔆👠🔪🍯🏇⌛⏳🍨🍦📥📨📱🎃👖🔑👘🏮📒🍋💄🔒🔏🍭➿🔊📢🔅🔍🔎🀄📫📪📬📭👞🍖📣🍈📝🎤🔬💽💸💰🎓🚵🎥🎹🎼🔇📛👔📰🔕📓📔🔩🍢📖📂:橙色_book:📤📦📄📃📟📎🍑🍐✏✏☎️💊:pine苹果:🍕📯📮👝🍗💷👛📌📻🍜🎀🍚🍙🍘🎑💍🏉🎽🍶👡🎅🛰🎷🎒✂📜💺🍧👕👞🚿🎿🚬🏂⚽🔉👾♠🍝❇🎇🔈🍲📏🍓🏄🍣🍠🏊💉🎉🎋🍊🍵☎📞🔭🎾🚽🍅🎩📐🏆🍹🎺👕📺🔓📼📹🎮🎻⌚🍉🎐🍷👚👒🔧💴
Places
🚡✈🚑⚓🚛🏧🏦💈🔰🚲🚙⛵️🌉🚅🚄🚌🚏🚗🎠:checke红色_flag:⛪🎪🌇🌇🇨🇳🚧🏪🎌🇩🇪🏬🇪🇸🏰🏤🏭🎡🚒⛲🇫🇷⛽🇬🇧🚁🏥🏨♨🏠🏡🇮🇹🏮🗾🏯🇯🇵🇰🇷🚈🏩🚐🚝🗻🚠🚞🗿🏢🚘🚍🚔🚖🎭🚓🏤🚃🌈:红色_car:🚀🎢🚨📍🚣🇷🇺⛵🏫🚢🎰🚤🌠🚉🗽🚂🌅🌄🚟🚕⛺🎫🗼🚜🚥🚆🚆🚊🚩🚎🚚🇬🇧🇺🇸🚦⚠💒
Symbols
💯🔢🅰🆎🔤🔡🉑♒♈◀⏬⏫⬇🔽▶⤵⤴⬅↙↘➡↪⬆↕🔼↖↗🔃🔄🅱🚼🔙🛄☑‼⚫⬛◾◼▪🔲♋🔠♑💹🚸🎦🆑🕐🕙🕥🕚🕦🕛🕧🕜🕑🕝🕒🕞🕓🕟🕔🕠🕕🕡🕖🕢🕗🕣🕘🕤㊗🆒©➰💱🛃💠🚯8️⃣✴✳🔚⏩5️⃣4️⃣🆓♊#️⃣💟✔➗💲❗️➖✖➕🆔🉐ℹ⁉🔟🈁🔵🔷:large_橙色_diamond:🛅↔↩♌♎🔗ⓜ🚹🚇📴:negative_squa红色_cross_mark:🆕🆖9️⃣🚳⛔🚫📵🚷🚭🚱⭕🅾🆗🔛1️⃣⛎🅿〽🛂♓🚰🚮🔘♻:红色_circle::registe红色:🔁🔂🚻⏪🈂♐♏㊙7️⃣:shipit:📶6️⃣🔯🔹:small_橙色_diamond::small_红色_triangle::small_红色_triangle_down:🔜🆘🔣♉3️⃣™🔝🔱🔀2️⃣🈹🈴🈺🈯🈷🈶🈵🈚🈸🈲🈳🔞🆙📳♍🆚〰🚾♿✅⚪💮⬜◽◻▫🔳🚺❌0️⃣
Insert
|
|
^^insert^^
^^insert 倾斜^^ ^^insert 倾斜 2^^
^^_insert 倾斜_^^ ^^insert 倾斜 2^^
^^insert 加粗^^ ^^insert 加粗 2^^
^^__insert 加粗__^^ ^^insert 加粗 2^^
^^insert 倾斜 加粗^^ ^^insert 倾斜 加粗 2^^
^^___insert 倾斜 加粗___^^ ^^insert 倾斜 加粗 2^^
^^insert 倾斜 加粗^^ ^^insert 倾斜 加粗 2^^
^^_insert 倾斜 加粗_^^ ^^__insert 倾斜 加粗 2__^^
^^_insert 倾斜 加粗_^^ ^^insert 倾斜 加粗 2^^
^^insert 倾斜 加粗^^ ^^__insert 倾斜 加粗 2__^^