Code Sandbox
约 279 字
主题支持在 Markdown 文件中嵌入 Code Sandbox。
配置
此功能默认不启用,你可以在配置文件中启用它。
.vuepress/config.ts
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
markdown: {
codeSandbox: true,
},
}),
})注意区分大小写
嵌入语法是全小写的 @[codesandbox](id),而配置字段是驼峰 codeSandbox。
写成 codesandbox 会被主题的字段白名单静默丢弃,功能不会生效,也不会有任何报错。
语法
简单语法
将 Code Sandbox 嵌入到页面中
@[codesandbox](id)使用 Code Sandbox 跳转按钮
@[codesandbox button](workspace/id)更多选项
@[codesandbox title="xxx" layout="Editor+Preview" height="500px" navbar="false" console](id#filepath)id: Code Sandbox IDtitle: Code Sandbox 标题layout: 代码预览布局。可选值:Preview,Editor,Editor+Previewheight: 代码预览高度navbar: 是否显示导航栏,默认为 trueconsole: 是否显示控制台,默认为 falsefilepath: 文件路径
示例
codeSandbox 跳转按钮:
@[codesandbox button](reaction/5wyzu)输出:
codeSandbox 内嵌到页面中:
@[codesandbox](5wyzu)输出:
贡献者
更新日志
2026/10/13 15:56
查看所有更新日志
e4dae-docs: improve docs (#1071)于60619-docs: improve docs (#1069)于1d04d-feat: add builtin auto-import-components (#932)于0daf2-docs: improve docs (#929)于4d236-feat(theme)!: add collections support (#704)于0fd6c-refactor(theme): improve types and flat config (#524)于b600e-docs: update docs于4349a-docs: update doc于
