交互演示

大约 4 分钟

让你的 VuePress 站点中的 Markdown 文件支持交互演示。

配置

// .vuepress/config.ts
import { defineUserConfig } from "vuepress";
import { hopeTheme } from "vuepress-theme-hope";

export default defineUserConfig({
  theme: hopeTheme({
    mdEnhance: {
      // 在此放置交互演示配置
      playground: {
        // 添加预设
        presets: [
          "ts",
          "vue",
          {
            name: "playground#language",
            component: "PlaygroundComponent",
            propsGetter: (
              playgroundData: PlaygroundData
            ): Record<string, string> => ({
              // 交互演示属性
            }),
          },
        ],
        // 设置内置预设 (可选)
        config: {
          ts: {
            // ...
          },
          vue: {
            // ...
          },
        },
      },
    },
  }),
});

// .vuepress/config.js
import { hopeTheme } from "vuepress-theme-hope";

export default {
  theme: hopeTheme({
    mdEnhance: {
      // 在此放置交互演示配置
      playground: {
        // 添加预设
        presets: [
          "ts",
          "vue",
          {
            name: "playground#language",
            component: "PlaygroundComponent",
            propsGetter: (
              playgroundData: PlaygroundData
            ): Record<string, string> => ({
              // 交互演示属性
            }),
          },
        ],
        // 设置内置预设 (可选)
        config: {
          ts: {
            // ...
          },
          vue: {
            // ...
          },
        },
      },
    },
  }),
};

使用

你应该通过 plugins.mdEnhance 中的 playground.presets 添加预设。

要使用交互演示，你应该使用一个名为 playground#preset 的容器。

在其中，你可以使用 3 个指令：

@file fileName 紧跟文件的代码块
@import importMapFileName 紧跟一个自定义“导入映射”的 json 代码块
@setting 紧跟一个自定义设置的 json 代码块

你可以查看以下演示以查看更多详细信息。

可用预设

目前，我们支持 ts 和 vue 预设，我们期待更多来自 PR 的预设。

如果你想添加自己的交互演示，可以在高级用法中添加你自己的预设。同时我们欢迎为你的精彩预设创建 PR。

TS 预设

TS 预设默认使用官方交互演示，不支持多个 ts 文件，所以你需要做的就是通过 @file xxx.ts 指令添加一个 ts 文件 (文件名不重要，但需要 .ts 文件扩展名)。

要使用定制化的编译器选项，你可以通过 @setting 指令提供一个。但请注意，官方 TS 交互演示并不支持所有的编译器。

同时，你可以通过插件选项中的 playground.config.ts 自定义默认的 compilerOption，通过 service 选项可以使用官方交互演示之外的其他服务，以防你想部署自己的交互演示站点。

Vue 预设

Vue 预设默认使用官方交互演示，并不像 Vue 交互演示支持自定义选项。因此，如果你严重依赖 Vue 交互演示，我们建议你改用 Vue 交互演示。

但是如果你只想要几个演示而不是捆绑整个 Vue 交互演示，你可以使用这个预设来创建一个 <iframe>。

@setting 指令中只有 service、dev 和 ssr 选项可用。

案例

TS

TS 案例 1

代码

::: playground#ts TS 案例 1

@file index.ts

```ts
const msg = "你好世界";

const speak = (msg: string) => console.log(msg);

speak(msg);
```

:::

TS 案例 2

代码

::: playground#ts TS 案例 2

@file index.ts

```ts
const msg = "你好世界";

const speak = (msg: string) => console.log(msg);

speak(msg);
```

@setting

```json
{
  "target": "es5"
}
```

:::

Vue

使用自定义导入的 Vue 案例

代码

::: playground#vue 使用自定义导入的 Vue 案例

@file App.vue

```vue
<script setup>
import { ref } from "vue";

import Comp from "./Comp.vue";

const msg = ref("Hello World!");
</script>

<template>
  <h1>{{ msg }}</h1>
  <input v-model="msg" />
  <Comp />
</template>
```

@file Comp.vue

```vue
<template>
  <div>Comp</div>
</template>
```

@import

```json
{
  "imports": {
    "vue": "https://sfc.vuejs.org/vue.runtime.esm-browser.js"
  }
}
```

:::

使用自定义设置的 Vue 案例

代码

::: playground#vue 使用自定义设置的 Vue 案例

@file App.vue

```vue
<script setup>
import { ref } from "vue";

const msg = ref("Hello Playground!");
</script>

<template>
  <h1>{{ msg }}</h1>
  <input v-model="msg" />
</template>
```

@setting

```json
{
  "dev": true,
  "ssr": true
}
```

:::

高级用法

你可以提供自己的预设。

interface PlaygroundCodeConfig {
  /**
   * 代码块扩展名
   *
   * @description 它基于文件名，而不是代码块语言
   */
  ext: string;

  /**
   * 代码块内容
   */
  content: string;
}

interface PlaygroundData {
  /**
   * 交互演示标题
   */
  title?: string;

  /**
   * Import map 文件名
   *
   * @default 'import-map.json'
   */
  importMap?: string;

  /**
   * 交互演示文件信息
   */
  files: Record<
    /**
     * 文件名
     */
    string,
    /**
     * 文件详情
     */
    PlaygroundCodeConfig
  >;

  /**
   * 交互演示设置
   *
   * @description 它是设置指令后的 json 内容的解析结果
   */
  settings: Record<string, unknown>;

  /**
   * 根据交互演示内容生成的 hash key
   */
  key: string;
}

interface PlaygroundOptions {
  /**
   * 交互演示容器名
   */
  name: string;

  /**
   * 交互演示组件名称
   *
   * @default 'Playground'
   */
  component?: string;

  /**
   * 属性获取器
   */
  propsGetter: (data: PlaygroundData) => Record<string, string>;
}

我们为 getter 函数提供了一个 playgroundData 对象，你应该提供下列内容:

通过 name 选项提供容器名称
通过 component 选项提供客户端组件名称
通过 propsGetter 选项提供一个接收 playgroundData 并返回格式为 attr → value 属性映射的函数

交互演示

# 配置

# 使用

# 可用预设

# 案例

# TS

# Vue

# 高级用法

配置

使用

可用预设

案例

TS

Vue

高级用法