<div class="mr-2">
    <i class="eva text-  text-2xl"></i>
</div><p style="margin: 0;">本页面是对优秀的 <a
class="link"
href="http://learn.getgrav.org/content/markdown"target="_blank" rel="noopener">Grav原始页面</a

的复制。唯一的区别是关于图片自定义的信息(调整大小</a

…)

让我们面对现实:为网页写内容是很累人的。所见即所得(WYSIWYG)编辑器虽然可以减轻这项工作,但通常会产生糟糕的代码,更糟的是会产生难看的网页。

Markdown是一种更好的编写HTML的方式,没有通常伴随的复杂性和丑陋。

主要优点包括:

Markdown学习简单,额外字符很少,所以写内容也更快。
使用markdown写作出错的可能性更小。
生成有效的XHTML输出。
保持内容和视觉显示的分离,所以不会搞乱网站的外观。
可以使用任何文本编辑器或Markdown应用程序。
使用Markdown是一种享受!

Markdown的作者John Gruber是这样说的:

Markdown格式化语法的首要设计目标是尽可能的易读。这个想法是,Markdown格式的文档应该是可以直接发布的,作为纯文本,不会看起来像被标记标签或格式说明污染。虽然Markdown的语法受到几个现有的文本到HTML过滤器的影响,但Markdown语法的最大灵感来源是纯文本电子邮件的格式。 – John Gruber

Grav内置支持 Markdown 和Markdown Extra 。你必须在system.yaml配置文件中启用Markdown Extra。

不多说了,让我们看看Markdown的主要元素以及生成的HTML是什么样的:

<div class="mr-2">
    <i class="eva text-blue-400 eva-question-mark-circle-outline text-2xl"></i>
</div><p style="margin: 0;"><i class="fas fa-bookmark"></i> 为方便将来参考,请收藏此页面!</p></div>

标题系统

通过前置井号数量定义6级标题（h1-h6），具体语法如下：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


# h1 Heading

## h2 Heading

### h3 Heading

#### h4 Heading

##### h5 Heading

###### h6 Heading

Renders to:

h1 Heading

h2 Heading

h3 Heading

h4 Heading

h5 Heading

h6 Heading

HTML:

1
2
3
4
5
6


<h1>h1 Heading</h1>
<h2>h2 Heading</h2>
<h3>h3 Heading</h3>
<h4>h4 Heading</h4>
<h5>h5 Heading</h5>
<h6>h6 Heading</h6>

注释规范

注释需符合HTML语法标准

1
2
3


<!--
This is a comment
-->

下面的注释不应该被看到:

水平分割线

使用HTML <hr> 元素在段落间创建主题分隔，Markdown支持三种等效语法： In markdown, you can create a <hr> with any of the following:

___: 三个连续的下划线
---: 三个连续的破折号
***: 三个连续的星号

渲染效果:

正文

普通文本会被包裹在 <p></p> 标签中渲染为HTML。例如这段文本: 正文普通文本会被包裹在 <p></p> 标签中渲染为HTML。例如这段文本: 普通文本会像正常一样被包裹在 <p></p> 标签中渲染为HTML。

比如这段文本: 普通文本会像正常一样被包裹在 <p></p> 标签中渲染为HTML。

比如这段文本:

1

Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.

renders to this HTML:

1
2
3
4
5
6


<p>
  Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et
  legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis
  inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei
  qui, vide sensibus vim ad.
</p>

Emphasis

Bold

For emphasizing a snippet of text with a heavier font-weight.

The following snippet of text is rendered as bold text.

1

**rendered as bold text**

renders to:

rendered as bold text

and this HTML

1

<strong>rendered as bold text</strong>

Italics

For emphasizing a snippet of text with italics.

The following snippet of text is rendered as italicized text.

1

_rendered as italicized text_

renders to:

rendered as italicized text

and this HTML:

1

<em>rendered as italicized text</em>

Strikethrough

In GFM (GitHub flavored Markdown) you can do strikethroughs.

1

~~Strike through this text.~~

Which renders to:

~~Strike through this text.~~

HTML:

1

<del>Strike through this text.</del>

Blockquotes

For quoting blocks of content from another source within your document.

Add > before any text you want to quote.

1

> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.

Renders to:

Fusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.

and this HTML:

1
2
3
4
5
6
7


<blockquote>
  <p>
    <strong>Fusion Drive</strong> combines a hard drive with a flash storage
    (solid-state drive) and presents it as a single logical volume with the
    space of both drives combined.
  </p>
</blockquote>

Blockquotes can also be nested:

1
2
3
4
5


> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
>
> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
>
> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.

Renders to:

Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.

Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.

Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.

Notices

<div class="mr-2">
    <i class="eva text-  text-2xl"></i>
</div><p style="margin: 0;">The old mechanism for notices overriding the block quote syntax (<code>&gt;&gt;&gt;</code>) has been deprecated. Notices are now handled via a dedicated plugin called <a
class="link"
href="https://github.com/getgrav/grav-plugin-markdown-notices"target="_blank" rel="noopener">Markdown Notices</a

Lists

Unordered

A list of items in which the order of the items does not explicitly matter.

You may use any of the following symbols to denote bullets for each list item:

1
2
3
4
5


- valid bullet

* valid bullet

- valid bullet

For example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
  - Phasellus iaculis neque
  - Purus sodales ultricies
  - Vestibulum laoreet porttitor sem
  - Ac tristique libero volutpat at
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
- Eget porttitor lorem

Renders to:

Lorem ipsum dolor sit amet
Consectetur adipiscing elit
Integer molestie lorem at massa
Facilisis in pretium nisl aliquet
Nulla volutpat aliquam velit
- Phasellus iaculis neque
- Purus sodales ultricies
- Vestibulum laoreet porttitor sem
- Ac tristique libero volutpat at
Faucibus porta lacus fringilla vel
Aenean sit amet erat nunc
Eget porttitor lorem

And this HTML

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


<ul>
  <li>Lorem ipsum dolor sit amet</li>
  <li>Consectetur adipiscing elit</li>
  <li>Integer molestie lorem at massa</li>
  <li>Facilisis in pretium nisl aliquet</li>
  <li>
    Nulla volutpat aliquam velit
    <ul>
      <li>Phasellus iaculis neque</li>
      <li>Purus sodales ultricies</li>
      <li>Vestibulum laoreet porttitor sem</li>
      <li>Ac tristique libero volutpat at</li>
    </ul>
  </li>
  <li>Faucibus porta lacus fringilla vel</li>
  <li>Aenean sit amet erat nunc</li>
  <li>Eget porttitor lorem</li>
</ul>

Ordered

A list of items in which the order of items does explicitly matter.

1
2
3
4
5
6
7
8


1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa
4. Facilisis in pretium nisl aliquet
5. Nulla volutpat aliquam velit
6. Faucibus porta lacus fringilla vel
7. Aenean sit amet erat nunc
8. Eget porttitor lorem

Renders to:

Lorem ipsum dolor sit amet
Consectetur adipiscing elit
Integer molestie lorem at massa
Facilisis in pretium nisl aliquet
Nulla volutpat aliquam velit
Faucibus porta lacus fringilla vel
Aenean sit amet erat nunc
Eget porttitor lorem

And this HTML:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


<ol>
  <li>Lorem ipsum dolor sit amet</li>
  <li>Consectetur adipiscing elit</li>
  <li>Integer molestie lorem at massa</li>
  <li>Facilisis in pretium nisl aliquet</li>
  <li>Nulla volutpat aliquam velit</li>
  <li>Faucibus porta lacus fringilla vel</li>
  <li>Aenean sit amet erat nunc</li>
  <li>Eget porttitor lorem</li>
</ol>

TIP: If you just use 1. for each number, Markdown will automatically number each item. For example:

1
2
3
4
5
6
7
8


1. Lorem ipsum dolor sit amet
1. Consectetur adipiscing elit
1. Integer molestie lorem at massa
1. Facilisis in pretium nisl aliquet
1. Nulla volutpat aliquam velit
1. Faucibus porta lacus fringilla vel
1. Aenean sit amet erat nunc
1. Eget porttitor lorem

Renders to:

Lorem ipsum dolor sit amet
Consectetur adipiscing elit
Integer molestie lorem at massa
Facilisis in pretium nisl aliquet
Nulla volutpat aliquam velit
Faucibus porta lacus fringilla vel
Aenean sit amet erat nunc
Eget porttitor lorem

代码展示

行内代码

Wrap inline snippets of code with `.

1

In this example, `<section></section>` should be wrapped as **code**.

Renders to:

In this example, <section></section> should be wrapped as code.

HTML:

1
2
3
4


<p>
  In this example, <code>&lt;section&gt;&lt;/section&gt;</code> should be
  wrapped as <strong>code</strong>.
</p>

Indented code

Or indent several lines of code by at least two spaces, as in:

1
2
3
4


    // Some comments
    line 1 of code
    line 2 of code
    line 3 of code

Renders to:

// Some comments
line 1 of code
line 2 of code
line 3 of code

HTML:

1
2
3
4
5
6
7
8


<pre>
  <code>
    // Some comments
    line 1 of code
    line 2 of code
    line 3 of code
  </code>
</pre>

Block code “fences”

Use “fences” ``` to block in multiple lines of code.

1

Sample text here...

HTML:

1
2
3


<pre>
  <code>Sample text here...</code>
</pre>

Syntax highlighting

GFM, or “GitHub Flavored Markdown” also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code “fence”, ```js, and syntax highlighting will automatically be applied in the rendered HTML.

See syntaxhighlight.md">Code Highlighting for additional documentation.

For example, to apply syntax highlighting to JavaScript code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20


    ```js
    grunt.initConfig({
      assemble: {
        options: {
          assets: 'docs/assets',
          data: 'src/data/*.{json,yml}',
          helpers: 'src/custom-helpers.js',
          partials: ['src/partials/**/*.{hbs,md}']
        },
        pages: {
          options: {
            layout: 'default.hbs'
          },
          files: {
            './': ['src/templates/pages/index.hbs']
          }
        }
      }
    };
    ```

Renders to:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


grunt.initConfig({
  assemble: {
    options: {
      assets: 'docs/assets',
      data: 'src/data/*.{json,yml}',
      helpers: 'src/custom-helpers.js',
      partials: ['src/partials/**/*.{hbs,md}']
    },
    pages: {
      options: {
        layout: 'default.hbs'
      },
      files: {
        './': ['src/templates/pages/index.hbs']
      }
    }
  }
};

Tables

Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.

1
2
3
4
5


| 选项 | 功能描述                                                               |
| ------ | ------------------------------------------------------------------------- |
| data   | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default.    |
| ext    | extension to be used for dest files.                                      |

Renders to:

选项	功能描述
data	path to data files to supply the data that will be passed into templates.
engine	engine to be used for processing templates. Handlebars is the default.
ext	extension to be used for dest files.

And this HTML:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


<table>
  <tr>
    <th>Option</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>data</td>
    <td>
      path to data files to supply the data that will be passed into templates.
    </td>
  </tr>
  <tr>
    <td>engine</td>
    <td>
      engine to be used for processing templates. Handlebars is the default.
    </td>
  </tr>
  <tr>
    <td>ext</td>
    <td>extension to be used for dest files.</td>
  </tr>
</table>

Right aligned text

Adding a colon on the right side of the dashes below any heading will right align text for that column.

1
2
3
4
5


| Option |                                                               Description |
| -----: | ------------------------------------------------------------------------: |
|   data | path to data files to supply the data that will be passed into templates. |
| engine |    engine to be used for processing templates. Handlebars is the default. |
|    ext |                                      extension to be used for dest files. |

Option	Description
data	path to data files to supply the data that will be passed into templates.
engine	engine to be used for processing templates. Handlebars is the default.
ext	extension to be used for dest files.

Links

Basic link

1

[Assemble](http://assemble.io)

Renders to (hover over the link, there is no tooltip):

Assemble

HTML:

1

<a href="http://assemble.io">Assemble</a>

1

[Upstage](https://github.com/upstage/ "Visit Upstage!")

Renders to (hover over the link, there should be a tooltip):

Upstage

HTML:

1

<a href="https://github.com/upstage/" title="Visit Upstage!">Upstage</a>

Named Anchors

Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters:

1
2
3
4
5


# Table of Contents

- [Chapter 1](#chapter-1)
- [Chapter 2](#chapter-2)
- [Chapter 3](#chapter-3)

will jump to these sections:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


## Chapter 1 <a id="chapter-1"></a>

Content for chapter one.

## Chapter 2 <a id="chapter-2"></a>

Content for chapter one.

## Chapter 3 <a id="chapter-3"></a>

Content for chapter one.

NOTE that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.

Images

Images have a similar syntax to links but include a preceding exclamation point.

1

![Minion](https://octodex.github.com/images/minion.png)

1

![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")

Like links, Images also have a footnote style syntax

Alternative usage : note images

1

![Alt text][id]

With a reference later in the document defining the URL location:

[id]: https://octodex.github.com/images/dojocat.jpg  "The Dojocat"

Resizing image

Add HTTP parameters width and/or height to the link image to resize the image. Values are CSS values (default is auto).

1

![Minion](https://octodex.github.com/images/minion.png?width=20pc)

1

![Minion](https://octodex.github.com/images/minion.png?height=50px)

1

![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px)

Add CSS classes

Add a HTTP classes parameter to the link image to add CSS classes. shadowand border are available but you could define other ones.

1

![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow)

1

![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border)

1

![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow)

Add a HTTP featherlight parameter to the link image to disable lightbox. By default lightbox is enabled using the featherlight.js plugin. You can disable this by defining featherlight to false.

1

![Minion](https://octodex.github.com/images/minion.png?featherlight=false)

标题系统

h1 Heading

h2 Heading

h3 Heading

h4 Heading

h5 Heading

h6 Heading

注释规范

水平分割线

正文

Emphasis

Bold

Italics

Strikethrough

Blockquotes

Notices

Lists

Unordered

Ordered

代码展示

行内代码

Indented code

Block code “fences”

Syntax highlighting

Tables

Right aligned text

Links

Basic link

Add a tooltip

Named Anchors

Images

Alternative usage : note images

Resizing image

Add CSS classes

Lightbox