VuePress 主要从 Markdown 文件生成页面。因此,你可以使用它轻松生成文档或博客站点。

你应该创建和编写 Markdown 文件,以便 VuePress 可以根据文件结构将它们转换为不同的页面。

Markdown 介绍

如果你是一个新手,还不会编写 Markdown,请先阅读 Markdown 介绍Markdown 演示

Markdown 配置

VuePress 通过 Frontmatter 为每个 Markdown 页面引入配置。

::: info

Frontmatter 是 VuePress 中很重要的一个概念,如果你不了解它,你需要阅读 Frontmatter 介绍

:::

Markdown 扩展

VuePress 会使用 markdown-it 来解析 Markdown 内容,因此可以借助于 markdown-it 插件来实现 语法扩展

VuePress 扩展

为了丰富文档写作,VuePress 对 Markdown 语法进行了扩展。

关于这些扩展,请阅读 VuePress 中的 Markdown 扩展

主题扩展

通过 [vuepress-plugin-md-enhance][md-enhance],主题扩展了更多 Markdown 语法,提供更加丰富的写作功能。

自定义容器

::: v-pre

安全的在 Markdown 中使用 。

:::

::: info 自定义标题

信息容器,包含 代码链接

1
const a = 1;

:::

::: tip 自定义标题

提示容器

:::

::: warning 自定义标题

警告容器

:::

::: danger 自定义标题

危险容器

:::

::: details 自定义标题

详情容器

:::

代码块

::: code-tabs

@tab pnpm

1
pnpm add -D vuepress-theme-hope

@tab yarn

1
yarn add -D vuepress-theme-hope

@tab:active npm

1
npm i -D vuepress-theme-hope

:::

上下角标

19^th^ H2O

自定义对齐

::: center

我是居中的

:::

::: right

我在右对齐

:::

Attrs

一个拥有 ID 的 单词