MarkDown语法

Markdown 是做笔记、为网站创建内容以及生成可打印文档的快速、简便的方法。
官网 https://markdown.com.cn/basic-syntax/

1 速查表

1.1 基本语法

这些是 John Gruber 的原始设计文档中列出的元素。所有 Markdown 应用程序都支持这些元素。

元素Markdown 语法
标题(Heading)# H1<br>## H2<br>### H3
粗体(Bold)**bold text**
斜体(Italic)*italicized text*
引用块(Blockquote)> blockquote
有序列表(Ordered List)1. First item
2. Second item
3. Third item
无序列表(Unordered List)- First item<br>- Second item<br>- Third item<br>
代码(Code)`code`
分隔线(Horizontal Rule)---
链接(Link)[title](https://www.example.com)
图片(Image)![alt text](image.jpg)

1.2 扩展语法

这些元素通过添加额外的功能扩展了基本语法。但是,并非所有 Markdown 应用程序都支持这些元素。

元素Markdown 语法
表格(Table)\| Syntax \| Description \|<br>\| ----------- \| ----------- \|<br>\| Header \| Title \|<br>\| Paragraph \| Text \|
代码块(Fenced Code Block)` ```
{
“firstName”: “John”,
“lastName”: “Smith”,
“age”: 25
}
````
脚注(Footnote)Here’s a sentence with a footnote. [^1]
[^1]: This is the footnote.
标题编号(Heading ID)### My Great Heading {#custom-id}
定义列表(Definition List)term<br>: definition
删除线(Strikethrough)~~The world is flat.~~
任务列表(Task List)- [x] Write the press release<br>- [ ] Update the website<br>- [ ] Contact the media

2 语法

2.1 标题语法

要创建标题,请在单词或短语前面添加井号 (#) 。# 的数量代表了标题的级别。例如,添加三个 # 表示创建一个三级标题 (<h3>) (例如:### My Header)。

用’#‘来代表标题等级,’#'号越多,标题级别越低,一共有六级标题。

写完’#'之后需要和标题文字加一个空格隔开

'#'和标题文字之间要保留一个空格。

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

2.2 强调语法

粗体(Bold) 斜体(Italic)

要加粗文本,请在单词或短语的前后各添加两个星号(asterisks)或下划线(underscores)。如需加粗一个单词或短语的中间部分用以表示强调的话,请在要加粗部分的两侧各添加两个星号(asterisks)。

考虑到兼容性,建议使用星号

只需要用几个星*号把文字括起来就好了

*斜体*
**加粗**
***斜体加粗***

tips:*号和文字之间没有空格

效果如下:

斜体

加粗

斜体加粗

2.3 图片语法

使用感叹号 (!), 然后在方括号增加替代文本,图片链接放在圆括号里,括号里的链接后可以增加一个可选的图片标题文本。

插入图片Markdown语法代码:![图片alt](图片链接 "图片title")。

对应的HTML代码:<img src="图片链接" alt="图片alt" title="图片title">
![这是图片](/assets/img/philly-magic-garden.jpg "Magic Gardens")

平时使用的画,直接把图片粘贴进来就行,就会自动生成以上的格式

2.4 引用语法

要创建块引用,请在段落前添加一个 > 符号。

引用MarkDown语法

嵌套引用

引用块内可以还可以继续嵌套引用

2.5 列表语法

2.5.1 无序列表

要创建无序列表,请在每个列表项前面添加破折号 (-)、星号 (*) 或加号 (+) 。缩进一个或多个列表项可创建嵌套列表。

  • 事项1

  • 事项2

    • 事项3

tips:官方推荐使用破折号(-)

2.5.2 有序列表

要创建有序列表,请在每个列表项前添加数字并紧跟一个英文句点。
数字+英文点+空格进入 有序列表模式
数字不必按数学顺序排列,但是列表应当以数字 1 起始。
同样,有序列表中使用Tab键或继续嵌套语法可以实现嵌套

  1. 列表1

  2. 列表2

当然,还可以在列表中嵌套引用块或者代码块或者图片

2.6 代码语法

要将单词或短语表示为代码,请将其包裹在反引号 (`) 中。
就是将所要用的代码或英文放在两个反引号之间。
这里的反引号是键盘Esc下面的那个反引号。

表示代码

2.6.1 转义反引号

如果你要表示为代码的单词或短语中包含一个或多个反引号,则可以通过将单词或短语包裹在双反引号(``)中。

hello world

2.6.1 代码语法

要创建代码块,请将代码块的每一行缩进至少四个空格或一个制表符。

<html>
<head>
</head>
</html>

2.6.2 围栏试代码块

要创建不用缩进的代码块,请使用 围栏式代码块(fenced code blocks).

要在文本中插入一段代码块,来放一整段的代码
可以,使用三个反引号开头即可(```)
还可以选择对应的编程语言,同时支持高亮显示

package com.kayak.springboot.demo.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello() {
        return "HelloSpringBoot";
    }
}

语法高亮

许多Markdown处理器都支持受围栏代码块的语法突出显示。使用此功能,您可以为编写代码的任何语言添加颜色突出显示。要添加语法突出显示,请在受防护的代码块之前的反引号旁边指定一种语言。jsonjava``````

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
package com.kayak.springboot.demo.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello() {
        return "HelloSpringBoot";
    }
}

2.7 分割线语法

要创建分隔线,请在单独一行上使用三个或多个星号 (***)、破折号 (—) 或下划线 (___) ,并且不能包含其他内容。(一般用—,比较方便)

***
---
___

效果如下:




2.8 链接语法

2.8.1 方法1:链接文本放在中括号内,链接地址放在后面的括号中,链接title可选。使用ctrl + 左键点击可以触发

超链接Markdown语法代码:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-GjNSzWsf-1652409600522)(file:///C:/Users/zyz/AppData/Roaming/marktext/images/2022-05-12-17-14-30-image.png?msec=1652403375463)]-30-image.png" title=“” alt=“” width=“328”>

baidu

2.8.2 方法2:直接将链接地址复制到文本中,使用ctrl + 左键点击可以触发(许多Markdown处理器会自动将URL转换为链接。)

https://www.baidu.com/

如果您不希望自动链接URL,则可以通过将URL表示为带反引号的代码来删除该链接

https://www.baidu.com

2.8.3 给链接增加 Title

链接title是当鼠标悬停在链接上时会出现的文字,这个title是可选的,它放在圆括号中链接地址后面,跟链接地址之间以空格分隔。

这是一个链接 [Markdown语法](https://markdown.com.cn "最好的markdown教程")。

渲染效果如下:

这是一个链接 Markdown语法

2.8.4 网址和Email地址

使用尖括号可以很方便地把URL或者email地址变成可点击的链接。

<https://markdown.com.cn>
<fake@example.com>

渲染效果如下:

https://www.baidu.com

fake@example.com

2.8.5 带格式化的链接

强调链接, 在链接语法前后增加星号。 要将链接表示为代码,请在方括号中添加反引号。

--两个星号
I love supporting the **[EFF](https://eff.org)**.
--一个星号
This is the *[Markdown Guide](https://www.markdownguide.org)*.
See the section on [`code`](#code).

渲染效果如下:

I love supporting the EFF.
This is the Markdown Guide.
See the section on code.

2.9 转义字符语法

要显示原本用于格式化 Markdown 文档的字符,请在字符前面添加反斜杠字符 \ 。

\* Without the backslash, this would be a bullet in an unordered list.

渲染效果如下:

* hello world *

3.0 表格

要添加表,请使用三个或多个连字符(---)创建每列的标题,并使用管道(|)分隔每列。您可以选择在表的任一端添加管道。

| Syntax      | Description |
| ----------- | ----------- |
| Header      | Title       |
| Paragraph   | Text        |

效果图:

SyntaxDescription
HeaderTitle
ParagraphText

可以通过先创建两个表头,然后再通过工具修改表格

第一列第二列

3.1 删除线

您可以通过在单词中心放置一条水平线来删除单词。结果看起来像这样。此功能使您可以指示某些单词是一个错误,要从文档中删除。若要删除单词,请在单词前后使用两个波浪号~~

~~hello world. ~~ 大千世界,奇妙万千。

hello world. 大千世界,奇妙万千。

3.2 任务列表语法-复选框

任务列表使您可以创建带有复选框的项目列表。在支持任务列表的Markdown应用程序中,复选框将显示在内容旁边。要创建任务列表,请在任务列表项之前添加破折号-和方括号[ ],并在[ ]前面加上空格。要选择一个复选框,请在方括号[x]之间添加 x 。

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

效果显示:

  • 第一

  • 第二

  • 第三

3.3 使用 Emoji (绘文字)表情

3.3.1 复制和粘贴表情符号

在大多数情况下,您可以简单地从Emojipedia 等来源复制表情符号并将其粘贴到文档中。许多Markdown应用程序会自动以Markdown格式的文本显示表情符号。从Markdown应用程序导出的HTML和PDF文件应显示表情符号。

Tip: 如果您使用的是静态网站生成器,请确保将HTML页面编码为UTF-8。.

3.3.2 使用表情符号简码

一些Markdown应用程序允许您通过键入表情符号短代码来插入表情符号。这些以冒号开头和结尾,并包含表情符号的名称。

去露营了! :tent: 很快回来。

真好笑! :joy:

去露营了! ⛺️ 很快回来

好笑 😂

🆗

Note: 注意:您可以使用此表情符号简码列表,但请记住,表情符号简码因应用程序而异。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值