目录

Markdown语法

基本语法

标题

h1h6的标题在每个级别依次加一个#

1
2
3
4
5
6
# h1 标题
## h2 标题
### h3 标题
#### h4 标题
##### h5 标题
###### h6 标题

对应Typora里的快捷键是ctrl+1~6

标题 ID

要添加自定义标题 ID,请在与标题相同的行中将自定义 ID 放在花括号中:

1
### 一个很棒的标题 {#custom-id}

注释

1
2
3
<!--
这是一段注释
-->

不能看到以下的注释:

水平线

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

输出效果为:




内联HTML元素

1
2
3
<div class="class">
    这是 <b>HTML</b>
</div>

字体强调

1
2
3
4
5
6
7
*斜体*或_斜体_
**粗体**或__粗体__
~~删除线~~
***加粗和斜体***
~~**删除线和加粗**~~
~~*删除线和斜体*~~
~~***加粗, 斜体和删除线***~~

输出效果为:

斜体 斜体 粗体 粗体 删除线

加粗和斜体 删除线和加粗 删除线和斜体 加粗, 斜体和删除线

引用

在要引用的任何文本之前添加 >

1
> 这是引用的文本

这是引用的文本

引用可以嵌套:

1
2
> 第一层
>> 第二层

第一层

第二层

列表

无序列表

可以使用以下任何符号来表示无序列表中的项:

1
2
3
4
* 一项内容
	* 一项内容
- 一项内容
+ 一项内容

输出效果为:

  • 一项内容
    • 一项内容
  • 一项内容
  • 一项内容

对应Typora里的快捷键是ctrl+shift+]

有序列表

1
2
3
1. 第一项
2. 第二项
3. 第三项

输出效果为:

  1. 第一项
  2. 第二项
  3. 第三项

对应Typora里的快捷键是ctrl+shift+[

任务列表

任务列表使你可以创建带有复选框的列表。 要创建任务列表,请在任务列表项之前添加破折号 (-) 和带有空格的方括号 ([ ])。要选择一个复选框,请在方括号之间添加 x ([x])。

1
2
3
- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

输出效果为:

  • Write the press release
  • Update the website
  • Contact the media

代码

Typora启用代码块的快捷键是ctrl+shift+k

行内代码

` 包装行内代码段。

1
在这个例子中, `<section></section>` 会被包裹成 **代码**

输出效果为:

在这个例子中,<section></section> 会被包裹成 代码

围栏代码块

使用 “围栏” ``` 来生成一段带有语言属性的代码块。类似的有shortcode里的highlight

1
Sample text here...

语法高亮

要激活它,只需在第一个代码 “围栏” 之后直接添加你要使用的语言的文件扩展名,比如```js,语法高亮显示将自动应用于渲染的 HTML 中。

 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']
      }
    }
  }
};

Hugo 文档中的 语法高亮页面 介绍了有关语法高亮的更多信息,包括语法高亮的 shortcode。

  • linenos:配置行号。有效值是truefalsetable,或inlinefalse如果将其配置为在站点配置中启用,则将关闭行号。 table 将提供友好的复制粘贴代码块。
  • hl_lines:列出要突出显示的一组行号或行号范围。
  • linenostart=199:从199开始行号计数。
  • anchorlinenos:在行号上配置锚点。有效值为truefalse;
  • lineanchors:为行号上的锚点配置前缀。将带有后缀-,因此使用选项链接到行号1lineanchors=prefix会将锚点添加prefix-1到页面。
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
​```js {linenos=table,hl_lines=[8,"14-15"],linenostart=1}
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']
      }
    }
  }
};
​```

输出效果为:

 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']
      }
    }
  }
};

表格

Typora快捷键为ctrl+T

选项描述
data数据
txt文本

链接

基本链接

1
<https://fmx789.github.io>

https://fmx789.github.io

添加标题的链接

1
[我的博客](https://fmx789.github.io)

我的博客

对应Typora里的快捷键是ctrl+k

文内链接

1
[跳转到链接](#link-test)

同时在跳转到的地方加个标签,注意标签不要跟带#的标题放在同一行,如果是非标题则无所谓:

1
2
<a id="link-test"></a>
### 链接

跳转到“链接”标题

注意

如果要链接不同的文章,请查看此处

如果要鼠标悬停时显示提示信息,请查看此处

脚注

脚注使你可以添加注释和参考,而不会使文档正文混乱。

创建脚注时,在添加脚注引用的位置会出现带有链接的上标编号。

单击链接便会跳至页面底部的脚注内容。

1
2
3
4
5
6
脚注编号:
这是一个数字脚注[^1].
这是一个英文脚注[^label]
脚注内容:
[^1]: 这是一个数字脚注
[^one]: 这是一个带标签的脚注

这是一个数字脚注1. 这是一个英文脚注2

图片

1
![Alt text][id]

更丰富的图片功能详见本文此处

主题拓展语法

ruby注释

1
[内容]^(这是注释)

内容这是注释

分数

1
[1]/[3]

1/3

Font Awesome图标库

1
2
芜湖起飞! :(fas fa-rocket fa-fw): 
真开心! :(far fa-grin-tears):

芜湖起飞!

真开心!

转义字符

特殊情况下,文章内容与Markdown基本/拓展语法冲突时,可以使用转义字符来帮助渲染出想要的内容。

1
{?:}joy:

这将展示:joy:而不是😂。

参考链接


  1. 这是一个数字脚注 ↩︎

  2. 这是一个带标签的脚注 ↩︎