配置

插件配置

你可以设置以下插件选项来启用或禁用一些功能。

chartjs

• 类型: boolean
• 默认值: false
• 详情:
  • Chart.js

是否启用图表支持。

echarts

• 类型: boolean
• 默认值: false
• 详情:
  • ECharts

是否启用 ECharts 图表支持。

flowchart

• 类型: boolean
• 默认值: false
• 详情:
  • 流程图

是否启用流程图支持。

markmap

• 类型: boolean
• 默认值: false
• 详情:
  • Markmap

是否启用 Markmap 支持。

mermaid

• 类型: boolean
• 默认值: false
• 在 GFM 中启用: 是
• 详情:
  • Mermaid

是否启用 Mermaid 支持。

plantuml

• 类型: MarkdownItPlantumlOptions[] | boolean
• 默认值: false
• 详情:
  • Plantuml

是否启用 plantuml 支持。

playground

• 类型: PlaygroundGlobalOptions

  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 based on playground content
     *
     * 根据交互演示内容生成的 hash key
     */
    key: string;
  }
  
  interface PlaygroundOptions {
    /** 交互演示容器名 */
    name: string;
  
    /**
     * 交互演示组件名称
     *
     * @default "Playground"
     */
    component?: string;
  
    /** 属性获取器 */
    propsGetter: (data: PlaygroundData) => Record<string, string>;
  }
  
  interface TSPresetPlaygroundOptions extends CompilerOptions {
    /**
     * 交互演示外部地址
     *
     * @default "https://www.typescriptlang.org/play"
     */
    service?: string;
  }
  
  interface VuePresetPlaygroundOptions {
    /**
     * 交互演示外部地址
     *
     * @default "https://sfc.vuejs.org/"
     */
    service?: string;
  
    /**
     * 是否启用开发版本
     *
     * @default false
     */
    dev?: boolean;
  
    /**
     * 是否启用 SSR
     *
     * @default false
     */
    ssr?: boolean;
  }
  
  interface UnoPresetPlaygroundOptions {
    /**
     * 交互演示外部地址
     *
     * @default "https://unocss.dev/play"
     */
    service?: string;
  }
  
  type BuiltInPlaygroundPreset = "ts" | "vue" | "unocss";
  
  interface PlaygroundGlobalOptions {
    /** 交互演示预设 */
    presets: (BuiltInPlaygroundPreset | PlaygroundOptions)[];
    /** 交互演示配置 */
    config?: {
      ts?: TSPresetPlaygroundOptions;
      vue?: VuePresetPlaygroundOptions;
      unocss?: UnoPresetPlaygroundOptions;
    };
  }

• 必填: 否

• 详情:

  • 交互演示

交互演示选项。

kotlinPlayground

• 类型: boolean
• 默认值: false
• 详情:
  • Kotlin 交互演示

是否启用 Kotlin 交互演示支持。

vuePlayground

• 类型: boolean
• 默认值: false
• 详情:
  • Vue 交互演示

是否启用 Vue 交互演示支持。

demo

• 类型: CodeDemoGlobalOptions | boolean
• 默认值: false
• 详情:
  • 代码案例

是否启用代码案例支持。

demo.jsLib

• 类型: string[]
• 必填: 否

CodePen, JsFiddle 需要引入的外部 JS 库。

demo.cssLib

• 类型: string[]
• 必填: 否

CodePen, JsFiddle 需要引入的外部 CSS 库。

注意

上述两个选项仅仅是给第三方代码演示使用的，你需要自行在 head 中导入这些库。

demo.jsfiddle

• 类型: boolean
• 默认值: true

是否显示 JSFiddle 按钮

demo.codepen

• 类型: boolean
• 默认值: true

是否显示 CodePen 按钮

demo.codepenLayout

• 类型: "top" | "left" | "right"
• 默认值: "left"

CodePen 编辑器布局

demo.codepenEditors

• 类型: string
• 默认值: "101"

CodePen 编辑器状态

demo.editors

• 类型: string
• 默认值: "101"

CodePen 编辑器显示情况，第一位代表 HTML ，第二位代表 JS，第三位代表演示页面。

其他

以下是第三方代码演示使用的库地址，除非你的环境无法访问 unpkg 或访问缓慢，否则无需覆盖默认设置。

demo.babel

默认值: "https://unpkg.com/@babel/standalone/babel.min.js"

demo.vue

默认值: "https://unpkg.com/vue/dist/vue.global.prod.js"

demo.react

默认值: "https://unpkg.com/react/umd/react.production.min.js"

demo.reactDOM

默认值: "https://unpkg.com/react-dom/umd/react-dom.production.min.js"

sandpack

• 类型: boolean
• 默认值: false

是否启用 Sandpack 交互演示。

客户端配置

defineEChartsConfig

interface EChartsConfig {
  /**
   * ECharts 全局选项
   */
  option?: EChartsOption;

  /**
   * ECharts 初始化函数
   */
  setup?: () => Promise<void>;
}

const defineEChartsConfig: (config: EChartsConfig) => void;

定义需要传递给 ECharts 的全局配置选项和设置函数。

defineMermaidConfig

export type MermaidOptions = Omit<
  MermaidConfig,
  "startOnLoad" | "themeVariables"
> & {
  themeVariables?:
    | MermaidThemeVariables
    | ((isDarkMode: boolean) => MermaidThemeVariables);
};

const defineMermaidConfig: (options: MermaidOptions) => void;

定义需要传递给 Mermaid 的配置选项。额外地，你可以通过 themeVariables 选项来设置主题变量。

defineKotlinPlaygroundConfig

interface KotlinPlaygroundOptions {
  server?: string;
  version?: string;

  onChange?: (code: string) => void;
  onRun?: () => void;
  onError?: () => void;
  getJsCode?: (code: string) => void;
  onTestPassed?: () => void;
  onTestFailed?: () => void;
  onOpenConsole?: () => void;
  onCloseConsole?: () => void;
  callback?: (targetNode: HTMLElement, mountNode: HTMLElement) => void;
  getInstance?: (instance: KotlinPlaygroundInstance) => void;
}

const defineKotlinPlaygroundConfig: (options: KotlinPlaygroundOptions) => void;

定义需要传递给 kotlin-playground 的配置选项。

defineSandpackConfig

 interface SandpackConfig {
  /**
   * 指定模板
   */
  template?: SandpackPredefinedTemplate;

  /**
   * sandpack 配置项
   */
  options?: SandpackOptions;

  /**
   * sandpack customSetup 配置项
   */
  customSetup?: SandpackSetup;
}

const defineSandpackConfig = (config: SandpackConfig)=> void

定义需要传递给 sandpack-vue3 的选项。

defineVuePlaygroundConfig

export interface VuePlaygroundOptions
  extends Omit<ReplProps, "store" | "editor"> {
  /**
   * 指定 vue 版本
   */
  vueVersion?: string;

  /**
   * 指定默认的 Vue 开发运行时
   *
   * @default "https://unpkg.com/@vue/runtime-dom@${version}/dist/runtime-dom.esm-browser.js"
   */
  vueRuntimeDevUrl?: string | (() => string);

  /**
   * 指定默认的 Vue 生产运行时
   *
   * @default "https://unpkg.com/@vue/runtime-dom@${version}/dist/runtime-dom.esm-browser.prod.js"
   */
  vueRuntimeProdUrl?: string | (() => string);

  /**
   * 指定默认的 Vue 服务端渲染器
   *
   * @default "https://unpkg.com/@vue/server-renderer@${version}/dist/server-renderer.esm-browser.js"
   */
  vueServerRendererUrl?: string | (() => string);
}

const defineVuePlaygroundConfig: (options: VuePlaygroundOptions) => void;

定义需要传递给 @vue/repl 的选项。