进阶 sli.dev 2026-11-21 18:58:32 · 1 阅读

第23章 配置代码运行器(Code Runners)

第23章 配置代码运行器

​ 环境:client 此配置只在客户端运行,引入依赖包时请注意浏览器兼容性。

你可以在 Monaco Editor 中为自定义语言定义代码运行器。默认情况下,JavaScript 和 TypeScript 的运行器是内置的,直接在浏览器中执行,没有沙箱环境。如果需要更高级的集成方式,你也可以提供自己的代码运行器,比如把代码发送到远程服务器执行、在 Web Worker 中运行等,完全由你决定。

创建 ./setup/code-runners.ts,内容如下:

setup/code-runners.tsts ```ts import { defineCodeRunnersSetup } from '@slidev/types'

export default defineCodeRunnersSetup(() => { return { async python(code, ctx) { // 以某种方式执行代码并返回结果 const result = await executePythonCodeRemotely(code) return { text: result } }, html(code, ctx) { return { html: sanitizeHtml(code) } }, // 或其他语言,key 为语言 id } }) ```

Runner Context ​

第二个参数 ctx 是运行器上下文,包含以下属性:

ts ```ts export interface CodeRunnerContext { / * 通过 `runnerOptions` prop 传给运行器的选项。 */ options: Record / * 使用 shiki 高亮代码。 */ highlight: (code: string, lang: string, options?: Partial) => string / * 调用(其他)代码运行器来执行代码。 */ run: (code: string, lang: string) => Promise } ```

Runner Output ​

运行器可以返回文本、HTML 输出,或返回一个待挂载的元素。详见 https://github.com/slidevjs/slidev/blob/main/packages/types/src/code-runner.ts。

额外的运行器依赖 ​

默认情况下,Slidev 会扫描 Markdown 源码,自动为代码运行器导入所需的依赖。如果你想手动导入依赖,可以在 frontmatter 中使用 monacoRunAdditionalDeps 选项:

yaml ```yaml monacoRunAdditionalDeps: - ./path/to/dependency - lodash-es ```

TIP

路径相对于 snippets 目录解析。依赖名称必须与代码中实际导入的名称完全一致。

评论 (0)