Skip to content

Markdown 文本格式

Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车。

字体

文本强调是写作中的重要技巧,Markdown 提供了简洁的方式来实现粗体和斜体效果。

Markdown 可以使用以下几种字体:粗体和斜体。

粗体语法:

使用两个星号 ** 或两个下划线 __ 包围文字:

markdown
这是**粗体文字**使用星号
这是__粗体文字__使用下划线

结果:

这是 粗体文字 使用星号

这是 粗体文字 使用下划线

斜体语法:

使用一个星号 * 或一个下划线 _ 包围文字:

markdown
这是*斜体文字*使用星号
这是_斜体文字_使用下划线

结果:

这是 斜体文字 使用星号

这是 斜体文字 使用下划线

粗斜体组合:

使用三个星号 *** 或三个下划线 ___。

markdown
*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___

结果:

斜体文本

斜体文本

粗体文本

粗体文本

粗斜体文本

粗斜体文本

markdown
这段文字包含**粗体***斜体*和***粗斜体***的组合效果。

结果:

这段文字包含 粗体斜体粗斜体 的组合效果。

使用建议:

  • 推荐使用星号 * 而不是下划线 _,因为星号在各种 Markdown 解析器中兼容性更好
  • 不要过度使用强调,重点突出才有效果
  • 在中英文混合时,建议在强调符号前后加空格以提高可读性

分隔线

你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

markdown
***

* * *

*****

- - -

----------

显示效果:






删除线

如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线 ~~ 即可,实例如下:

markdown
GUOLIPING.COM
GOOGLE.COM
~~BAIDU.COM~~

显示效果:

GUOLIPING.COM

GOOGLE.COM

BAIDU.COM

下划线

下划线可以通过 HTML 的 <u> 标签来实现:

markdown
<u>带下划线文本</u>

显示效果如下所示:

显示效果

带下划线文本

脚注

脚注是对文本的补充说明。

Markdown 脚注的格式如下:

markdown
[^要注明的文本]

[^GUOLIPING]

显示效果:

[^要注明的文本]

注意

以上发现使用了脚注并没有生效,这是因为 标准 Markdown:需通过 markdown-it-footnote 插件支持而 VitePress: 默认不支持:需手动配置插件:

安装:

bash
npm install markdown-it-footnote --save-dev
# 或
yarn add markdown-it-footnote --dev

配置:

js
// .vitepress/config.js
import { defineConfig } from 'vitepress'
import footnote from'markdown-it-footnote'

export default defineConfig({
  markdown: {
    config: (md) => {
      md.use(footnote)
    }
  }
})

语法:

markdown
这是一个脚注[^test]

[^test]: 脚注内容

安装后的效果 这是测试[1]

行内代码标记

行内代码用于在正文中标记代码片段、命令、变量名等:

基本语法:

使用一个反引号 ` 包围代码:

markdown
使用 `git commit` 命令提交代码
变量 `userName` 存储用户名
在终端中输入 `npm install` 安装依赖

显示效果:

使用 git commit 命令提交代码

变量 userName 存储用户名

在终端中输入 npm install 安装依赖

包含反引号的代码:

当代码本身包含反引号时,使用两个反引号包围。

markdown
要显示反引号,使用 `` `code` `` 这样的格式

渲染效果:

显示效果:

要显示反引号,使用 `code` 这样的格式

应用场景:

  • 技术文档中的 API 名称、函数名
  • 配置文件中的参数名
  • 命令行指令
  • 键盘快捷键(如 Ctrl+C)

文本高亮(扩展语法)

文本高亮不是标准 Markdown 语法,但许多扩展支持:

常见语法(部分平台支持):

markdown
这是==高亮文本==

显示效果:

这是 ==高亮文本==

注意

显然这个在vite平台是不支持的,不过在普通的markdown文件中是可以的,在vitepress中可以使用以下代码

markdown
这是<mark>高亮文本</mark>

显示效果:

这是 高亮文本

段落和换行

段落的创建方法 在 Markdown 中,段落是文本的基本单位,理解段落规则对于正确格式化文档至关重要。

段落基本规则:

  • 段落由一个或多个连续的文本行组成
  • 段落之间由一个或多个空行分隔
  • 普通段落不应该用空格或制表符缩进

正确的段落写法:

markdown
这是第一个段落。它可以包含多个句子,内容可以很长,会自动换行显示。

这是第二个段落。注意上面有一个空行分隔。

这是第三个段落。

显示效果:

这是第一个段落。它可以包含多个句子,内容可以很长,会自动换行显示。

这是第二个段落。注意上面有一个空行分隔。

这是第三个段落。

常见错误:

markdown
这是第一段
这是第二段(错误:没有空行分隔)

    这是缩进段落(错误:不应该缩进)

强制换行技巧

有时需要在不创建新段落的情况下换行,Markdown 提供了几种方法:

方法一:行尾两个空格

在行尾添加两个或更多空格,然后按回车:

markdown
第一行内容(这里有两个空格)  
第二行内容

方法二:HTML 换行标签

markdown
第一行内容<br>
第二行内容

方法三:反斜杠(部分解析器支持)

markdown
第一行内容\
第二行内容

实际应用示例:

markdown
地址:北京市朝阳区  
电话:010-12345678  
邮箱:admin@runoob.com

诗歌示例:
床前明月光,  
疑是地上霜。  
举头望明月,  
低头思故乡。

显示效果:

地址:北京市朝阳区
电话:010-12345678
邮箱:admin@runoob.com

诗歌示例: 床前明月光,
疑是地上霜。
举头望明月,
低头思故乡。

空行的作用

空行在 Markdown 中扮演重要角色:

分隔段落:

markdown
第一段内容

第二段内容

显示效果:

第一段内容

第二段内容

分隔不同元素:

markdown
# 标题

段落内容

- 列表项1
- 列表项2

另一段内容

显示效果:

标题

段落内容

  • 列表项1
  • 列表项2

另一段内容

最佳实践建议:

  • 在标题和内容之间留空行
  • 在列表前后留空行
  • 在代码块前后留空行
  • 保持一致的空行使用习惯

  1. 这是脚注内容。 ↩︎