markdown-hint

向你的 VuePress 站点添加 GFM 警告和提示容器。

该插件已经集成到默认主题中。

使用方法

npm i -D @vuepress/plugin-markdown-hint@next

.vuepress/config.ts
import { markdownHintPlugin } from '@vuepress/plugin-markdown-hint'

export default {
  plugins: [
    markdownHintPlugin({
      // 启用提示容器，默认启用
      hint: true,
      // 启用 GFM 警告
      alert: true,
    }),
  ],
}

指南

默认情况下，我们支持 important、info、note、tip、warning、caution、details 容器与 markdown 容器：

提示

一个带有 code 和链接的自定义提示容器。

const a = 1

Demo

::: tip

一个带有 `code` 和[链接](https://example.com)的自定义提示容器。

```js
const a = 1
```

:::

要自定义容器的标题，你可以在命名容器后添加标题：

自定义标题

一个带有自定义标题的重要容器。

Demo

::: important 自定义标题

一个带有自定义标题的重要容器。

:::

容器可以只包含一个标题：

仅有标题

Demo

::: warning 仅有标题
:::

插件也提供了 alert 选项，以支持 GFM 警告：

> [!note]
> This is note text

> [!important]
> This is important text

> [!tip]
> This is tip text

> [!warning]
> This is warning text

> [!caution]
> This is caution text

选项

hintboolean

默认值true

是否启用提示容器，包括 important、info、note、tip、warning、caution、details。

alertboolean

是否启用 GFM 警告支持。

injectStylesboolean

默认值true

是否注入默认样式。

localesMarkdownHintPluginLocaleConfig

提示容器标题的本地化配置。

参考：多语言配置。

locales.<localePath>.importantstring

重要块的默认标题。

locales.<localePath>.notestring

注释块的默认标题。

locales.<localePath>.tipstring

提示块的默认标题。

locales.<localePath>.warningstring

注意块的默认标题。

locales.<localePath>.cautionstring

警告块的默认标题。

locales.<localePath>.infostring

信息块的默认标题。

locales.<localePath>.detailsstring

详情块的默认标题。