Markdown Code Config

About 1 min

The following options adds new code feature in markdown, and can be set under markdown property in theme options.

markdown.markdown.codeTabs

Type: boolean
Default: false
Details:
- Markdown → Code Tabs
- @vuepress/plugin-markdown-tab → codeTabs

Whether to enable tabs support.

markdown.playground

Type: PlaygroundGlobalOptions

import type { CompilerOptions } from "typescript";

interface PlaygroundCodeConfig {
  /**
   * Code block extension
   *
   * @description It's based on filename, not code fence language
   */
  ext
: string;

  /** Code block content */
  content
: string;
}

interface PlaygroundData {
  /** Title of Playground */
  title
?: string;

  /**
   * Import map file name
   *
   * @default "import-map.json"
   */
  importMap
?: string;

  /** Playground files info */
  files
: Record
<
    /** File name */
    string,
    /** File detail */
    PlaygroundCodeConfig
  >;

  /**
   * Playground settings
   *
   * @description It's parsed result of json content after setting directive
   */
  settings
: Record
<string, unknown>;

  /** hash key based on playground content */
  key
: string;
}

interface PlaygroundOptions {
  /** Playground container name */
  name
: string;

  /**
   * Playground component name
   *
   * @default "Playground"
   */
  component
?: string;

  /**
   * Props getter
   */
  propsGetter
: (data
: PlaygroundData) => Record
<string, string>;
}

interface TSPresetPlaygroundOptions extends CompilerOptions {
  /**
   * external playground service url
   *
   * @default "https://www.typescriptlang.org/play"
   */
  service
?: string;
}

interface VuePresetPlaygroundOptions {
  /**
   * external playground service url
   *
   * @default "https://sfc.vuejs.org/"
   */
  service
?: string;

  /**
   * Whether to use dev version
   *
   * @default false
   */
  dev
?: boolean;

  /**
   * Whether to enable SSR
   *
   * @default false
   */
  ssr
?: boolean;
}

interface UnoPresetPlaygroundOptions {
  /**
   * external playground service url
   *
   * @default "https://unocss.dev/play"
   */
  service
?: string;
}

type BuiltInPlaygroundPreset
 = "ts" | "vue" | "unocss";

interface PlaygroundGlobalOptions {
  /** Playground presets */
  presets
: (BuiltInPlaygroundPreset
 | PlaygroundOptions)[];
  /** Playground config */
  config
?: {
    ts
?: TSPresetPlaygroundOptions;
    vue
?: VuePresetPlaygroundOptions;
    unocss
?: UnoPresetPlaygroundOptions;
  };
}

Required: No
Details:
- Markdown → Playground