Markdown 代码配置
大约 2 分钟
以下选项在 markdown 中添加了新的代码功能,可以在主题选项的 markdown
属性下进行设置。
markdown.markdown.codeTabs
- 类型:
boolean
- 默认值:
false
- 详情:
是否启用选项卡支持。
markdown.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; }; }
必填: 否
详情:
交互演示选项。
markdown.vuePlayground
- 类型:
boolean
- 默认值:
false
- 详情:
是否启用 Vue 交互演示支持。
markdown.sandpack
- 类型:
boolean
- 默认值:
false
- 详情:
是否启用 Sandpack 交互演示支持。
markdown.demo
- 类型:
CodeDemoGlobalOptions | boolean
- 默认值:
false
- 详情:
是否启用代码演示支持。
markdown.demo.jsLib
- 类型:
string[]
- 必填: 否
CodePen, JsFiddle 需要引入的外部 JS 库。
markdown.demo.cssLib
- 类型:
string[]
- Required: No
CodePen, JsFiddle 需要引入的外部 CSS 库。
注意
上述两个选项仅仅是给第三方代码演示使用的,你需要自行在 head
中导入这些库。
markdown.demo.jsfiddle
- 类型:
boolean
- 默认值:
true
是否显示 JSFiddle 按钮
markdown.demo.codepen
- 类型:
boolean
- 默认值:
true
是否显示 CodePen 按钮
markdown.demo.codepenLayout
- 类型:
"top" | "left" | "right"
- 默认值:
"left"
CodePen 编辑器布局
markdown.demo.codepenEditors
- 类型:
string
- 默认值:
"101"
CodePen 编辑器状态
markdown.demo.editors
- 类型:
string
- 默认值:
"101"
CodePen 编辑器显示情况,第一位代表 HTML ,第二位代表 JS,第三位代表演示页面。