ruabick

简体中文
English

简体中文
English

Appearance

Return to top
On this page

Vue API 文档自动生成

markdown 写一个 API 组件，传入 src 属性。

md
<API src="../../../vitepress-demo-block/src/Demo.vue" lang="zh"></API>

<API src="../../../vitepress-demo-block/src/Demo.vue" lang="zh"></API>

生成的 API 文档:

<demo> Props

参数名描述类型默认值
code (必填)源码字符串(需经过encodeURIComponent处理)string-
highlighted-code (必填)string-
titlestring-
descstring-
langstring'vue'
default-expandbooleanfalse
import-mapRecord() => ({})

<demo> Slots

插槽名描述参数
default-

Demo.vue Props 内容如下

ts
const props = withDefaults(
  defineProps<{
    /**
     * @zh 源码字符串(需经过encodeURIComponent处理)
     */
    code: string;
    highlightedCode: string;
    title?: string;
    desc?: string;
    lang?: string;
    defaultExpand?: boolean;
    importMap?: Record<string, string>;
  }>(),
  {
    lang: 'vue',
    defaultExpand: false,
    importMap: () => ({}),
  },
);

const props = withDefaults(
  defineProps<{
    /**
     * @zh 源码字符串(需经过encodeURIComponent处理)
     */
    code: string;
    highlightedCode: string;
    title?: string;
    desc?: string;
    lang?: string;
    defaultExpand?: boolean;
    importMap?: Record<string, string>;
  }>(),
  {
    lang: 'vue',
    defaultExpand: false,
    importMap: () => ({}),
  },
);