概述

在 markdown 中，使用 ::: field 容器，用于描述字段信息，包括字段名称、字段类型、是否必填、默认值、详情等信息。

它适用于 描述配置中的字段、组件的 Props 等场景。

还可以使用额外的 :::: field-group 容器，用于组合多个 ::: field。

启用

该功能默认不启用，您需要在 theme 配置中启用它。

.vuepress/config.ts

export default defineUserConfig({
  theme: plumeTheme({
    markdown: {
      field: true, 
    },
  })
})

语法

<!-- 单个字段 -->
::: field name="字段名" type="类型" required default="默认值"
字段描述信息
:::

<!-- 字段组合 -->
:::: field-group

::: field name="字段名" type="类型" required default="默认值"
字段描述信息
:::

::: field name="字段名" type="类型" required default="默认值"
字段描述信息
:::

::::

属性

nameRequiredstring

字段名称

typeOptionalstring

字段的类型

requiredOptionalboolean

是否必填

optionalOptionalboolean

是否可选

deprecatedOptionalboolean

是否弃用

defaultOptionalstring

默认值， 如果为空字符串，应该使用 default="''"

示例

输入：

::: field name="theme" type="ThemeConfig" required default="{}"
主题配置
:::

::: field name="enabled" type="boolean" optional default="true"
是否启用
:::

输出：

themeRequiredThemeConfig

{}

主题配置

enabledOptionalboolean

true

是否启用

输入：

:::: field-group
::: field name="theme" type="ThemeConfig" required default="{ base: '/' }"
主题配置
:::

::: field name="enabled" type="boolean" optional default="true"
是否启用
:::

::: field name="callback" type="(...args: any[]) => void" optional default="() => {}"
<Badge type="tip" text="v1.0.0 新增"  />
回调函数
:::

::: field name="other" type="string" deprecated
<Badge type="danger" text="v0.9.0 弃用"  />
已弃用属性
:::
::::

输出：

themeRequiredThemeConfig

{ base: '/' }

主题配置

enabledOptionalboolean

true

是否启用

callbackOptional(...args: any[]) => void

() => {}

v1.0.0 新增

回调函数

otherDeprecatedstring

v0.9.0 弃用

已弃用属性

贡献者

pengzhanbo

更新日志

2025/10/7 15:13

查看所有更新日志

• 4d236-feat(theme)!: add collections support (#704)于 2025/10/7
• a8fac-feat(plugin-md-power): add deprecated prop support for field container, close #627 (#630)于 2025/6/29
• d1496-docs: update docs于 2025/4/30
• 56c5e-feat(plugin-md-power): add field and field-group container, close #566 (#579)于 2025/4/29