Mobile wallpaper 1Mobile wallpaper 2Mobile wallpaper 3Mobile wallpaper 4Mobile wallpaper 5Mobile wallpaper 6
2558 字
13 分钟
Markdown教程
2025-01-20
统计加载中...

Markdown教程#

一个Markdown示例,展示如何编写Markdown文件。本文整合了核心语法和扩展(GMF)。

块级元素#

段落和换行#

段落#

HTML标签:<p>

一个或多个空行。(空行是指只包含空格制表符的行。)

代码:

This will be
inline.
This is second paragraph.

预览:


This will be inline.

This is second paragraph.


换行#

HTML标签:<br />

在一行末尾添加两个或更多空格

代码:

This will be not
inline.

预览:


This will be not
inline.


标题#

Markdown支持两种标题样式:Setext和atx。

Setext#

HTML标签:<h1><h2>

使用**等号(=)**作为<h1>,**连字符(-)**作为<h2>,数量不限。

代码:

This is an H1
=============
This is an H2
-------------

预览:


This is an H1#

This is an H2#


atx#

HTML标签:<h1><h2><h3><h4><h5><h6>

在行首使用1-6个井号(#),分别对应<h1> - <h6>

代码:

# This is an H1
## This is an H2
###### This is an H6

预览:


This is an H1#

This is an H2#

This is an H6#

可选地,你可以「关闭」atx风格的标题。关闭的井号不需要与打开标题的井号数量匹配。

代码:

# This is an H1 #
## This is an H2 ##
### This is an H3 ######

预览:


This is an H1#

This is an H2#

This is an H3#


引用#

HTML标签:<blockquote>

Markdown使用电子邮件风格的**>**字符进行引用。如果你硬换行文本并在每行前添加>,看起来会更好。

代码:

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.

预览:


This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus adipiscing.


Markdown允许你偷懒,只在硬换行段落的第一行前添加>。

代码:

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

预览:


This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus adipiscing.


引用可以嵌套(即在引用内嵌套引用),通过添加额外级别的>。

代码:

> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.

预览:


This is the first level of quoting.

This is nested blockquote.

Back to the first level.


引用可以包含其他Markdown元素,包括标题、列表和代码块。

代码:

> ## This is a header.
>
> 1. This is the first list item.
> 2. This is the second list item.
>
> Here's some example code:
>
> return shell_exec("echo $input | $markdown_script");

预览:


This is a header.#

  1. This is the first list item.
  2. This is the second list item.

Here’s some example code:

return shell_exec("echo $input | $markdown_script");

列表#

Markdown支持有序(编号)和无序(项目符号)列表。

无序#

HTML标签:<ul>

无序列表使用星号(*)加号(+)连字符(-)

代码:

* Red
* Green
* Blue

预览:


  • Red
  • Green
  • Blue

等同于:

代码:

+ Red
+ Green
+ Blue

和:

代码:

- Red
- Green
- Blue

有序#

HTML标签:<ol>

有序列表使用数字后跟句点:

代码:

1. Bird
2. McHale
3. Parish

预览:


  1. Bird
  2. McHale
  3. Parish

你可能会意外触发有序列表,比如写这样的内容:

代码:

1986. What a great season.

预览:


  1. What a great season.

你可以使用**反斜杠转义(\)**句点:

代码:

1986\. What a great season.

预览:


1986. What a great season.


缩进#

引用#

要在列表项中放置引用,引用的>分隔符需要缩进:

代码:

* A list item with a blockquote:
> This is a blockquote
> inside a list item.

预览:


  • A list item with a blockquote:

    This is a blockquote inside a list item.


代码块#

要在列表项中放置代码块,代码块需要缩进两次——8个空格两个制表符

代码:

* A list item with a code block:
<code goes here>

预览:


  • A list item with a code block:

    <code goes here>

嵌套列表#

代码:

* A
* A1
* A2
* B
* C

预览:


  • A
    • A1
    • A2
  • B
  • C

代码块#

HTML标签:<pre>

将块中的每一行缩进至少4个空格1个制表符

代码:

This is a normal paragraph:
This is a code block.

预览:


This is a normal paragraph:

This is a code block.

代码块会一直持续到遇到没有缩进的行(或文章结尾)。

在代码块中,**&符号(&)和尖括号(<和>)**会自动转换为HTML实体。

代码:

<div class="footer">
&copy; 2004 Foo Corporation
</div>

预览:


<div class="footer">
&copy; 2004 Foo Corporation
</div>

以下部分「围栏代码块」和「语法高亮」是扩展,你可以使用其他方式编写代码块。

围栏代码块#

只需将你的代码包裹在 ``` 中(如下所示),你就不需要将其缩进四个空格。

代码:

Here's an example:
```
function test() {
console.log("notice the blank line before this function?");
}
```

预览:


Here’s an example:

function test() {
console.log("notice the blank line before this function?");
}

语法高亮#

在你的围栏块中,添加一个可选的语言标识符,我们会对其进行语法高亮(支持的语言)。

代码:

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

预览:


require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

水平线#

HTML标签:<hr />

在一行中放置三个或更多连字符(-)、星号(*)或下划线(_)。你可以在连字符或星号之间使用空格。

代码:

* * *
***
*****
- - -
---------------------------------------
___

预览:











表格#

HTML标签:<table>

这是一个扩展。

使用**竖线(|)**分隔列,**连字符(-)分隔标题,并使用冒号(:)**进行对齐。

外部竖线(|)和对齐是可选的。每个单元格至少有3个分隔符用于分隔标题。

代码:

| Left | Center | Right |
|:-----|:------:|------:|
aaa |bbb |ccc |
ddd |eee |fff |
A | B
---|---
123|456
A |B
--|--
12|45

预览:


LeftCenterRight
aaabbbccc
dddeeefff
AB
123456
AB
1245

行内元素#

链接#

HTML标签:<a>

Markdown支持两种链接样式:行内和引用。

行内#

行内链接格式如下:[链接文本](URL "标题")

标题是可选的。

代码:

This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.

预览:


This is an example inline link.

This link has no title attribute.


如果你引用的是同一服务器上的本地资源,你可以使用相对路径:

代码:

See my [About](/about/) page for details.

预览:


See my About page for details.


引用#

你可以预定义链接引用。格式如下:[id]: URL "标题"

标题也是可选的。当你引用链接时,格式如下:[链接文本][id]

代码:

[id]: http://example.com/ "Optional Title Here"
This is [an example][id] reference-style link.

预览:


This is an example reference-style link.


也就是说:

  • 包含链接标识符的方括号(不区分大小写,可选地从左边缘缩进最多三个空格);
  • 后跟冒号;
  • 后跟一个或多个空格(或制表符);
  • 后跟链接的URL;
  • 链接URL可以可选地用尖括号包围。
  • 可选地后跟链接的标题属性,用双引号或单引号括起来,或用括号括起来。

以下三个链接定义是等效的:

代码:

[foo]: http://example.com/ "Optional Title Here"
[foo]: http://example.com/ 'Optional Title Here'
[foo]: http://example.com/ (Optional Title Here)
[foo]: <http://example.com/> "Optional Title Here"

使用空方括号,链接文本本身将用作名称。

代码:

[Google]: http://google.com/
[Google][]

预览:


Google


强调#

HTML标签:<em><strong>

Markdown将**星号(*)下划线(_)**视为强调的指示器。一个分隔符将是<em>两个分隔符将是<strong>

代码:

*single asterisks*
_single underscores_
**double asterisks**
__double underscores__

预览:


single asterisks

single underscores

double asterisks

double underscores


但如果你用空格包围*或_,它将被视为文字星号或下划线。

你可以用反斜杠转义:

代码:

\*this text is surrounded by literal asterisks\*

预览:


*this text is surrounded by literal asterisks*


代码#

HTML标签:<code>

用**反引号(`)**包裹它。

代码:

Use the `printf()` function.

预览:


Use the printf() function.


要在代码跨度内包含文字反引号字符,你可以使用多个反引号作为开始和结束分隔符:

代码:

``There is a literal backtick (`) here.``

预览:


There is a literal backtick (`) here.


围绕代码跨度的反引号分隔符可能包含空格——开始后一个,结束前一个。这允许你在代码跨度的开头或结尾放置文字反引号字符:

代码:

A single backtick in a code span: `` ` ``
A backtick-delimited string in a code span: `` `foo` ``

预览:


A single backtick in a code span: `

A backtick-delimited string in a code span: `foo`


图片#

HTML标签:<img />

Markdown使用类似于链接的图像语法,允许两种样式:行内和引用。

行内#

行内图像语法如下:![替代文本](URL "标题")

标题是可选的。

代码:

![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")

预览:


Alt text

Alt text


也就是说:

  • 一个感叹号:!
  • 后跟一组方括号,包含图像的alt属性文本;
  • 后跟一组括号,包含图像的URL或路径,以及可选的标题属性,用双引号或单引号括起来。

引用#

引用样式的图像语法如下:![替代文本][id]

代码:

[img id]: https://s2.loli.net/2024/08/20/5fszgXeOxmL3Wdv.webp "Optional title attribute"
![Alt text][img id]

预览:


Alt text


删除线#

HTML标签:<del>

这是一个扩展。

GFM添加了删除线文本的语法。

代码:

~~Mistaken text.~~

预览:


Mistaken text.


杂项#

自动链接#

Markdown支持为URL和电子邮件地址创建「自动」链接的快捷方式:只需将URL或电子邮件地址用尖括号包围。

代码:

<http://example.com/>
<address@example.com>

预览:


http://example.com/

address@example.com


GFM会自动链接标准URL。

代码:

https://github.com/emn178/markdown

预览:


https://github.com/emn178/markdown


反斜杠转义#

Markdown允许你使用反斜杠转义来生成字面字符,否则这些字符在Markdown的格式化语法中会有特殊含义。

代码:

\*literal asterisks\*

预览:


*literal asterisks*


Markdown为以下字符提供反斜杠转义:

代码:

\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash mark
+ plus sign
- minus sign (hyphen)
. dot
! exclamation mark

内联HTML#

对于Markdown语法未涵盖的任何标记,你只需使用HTML本身。不需要在前面加上或分隔它来表示你正在从Markdown切换到HTML;你只需使用标签。

代码:

This is a regular paragraph.
<table>
<tr>
<td>Foo</td>
</tr>
</table>
This is another regular paragraph.

预览:


This is a regular paragraph.

Foo

This is another regular paragraph.


注意,Markdown格式化语法不会在块级HTML标签内处理

与块级HTML标签不同,Markdown语法会在行内标签内处理

代码:

<span>**Work**</span>
<div>
**No Work**
</div>

预览:


Work

**No Work**
***
Markdown教程
https://github.com/emn178/markdown
作者
emn178
发布于
2025-01-20
许可协议
无许可

部分信息可能已经过时

封面
Sample Song
Sample Artist
封面
Sample Song
Sample Artist
0:00 / 0:00