第25章 配置 Monaco 编辑器
配置 Monaco 环境:client 此配置函数只在客户端运行,导入依赖包时请确保浏览器兼容性。
创建 ./setup/monaco.ts,内容如下:
./setup/monaco.ts
```ts import { defineMonacoSetup } from '@slidev/types'
export default defineMonacoSetup(async (monaco) => { // 在这里用 `monaco` 进行配置 }) ```
了解更多 Monaco 配置细节。
TypeScript 类型
在 Monaco 中使用 TypeScript 时,Slidev 会自动为相关依赖安装类型定义。
```md ```ts {monaco} import { ref } from 'vue' import { useMouse } from '@vueuse/core'
const counter = ref(0) ``` ```
上面的例子中,只需确保 vue 和 @vueuse/core 已作为 dependencies 或 devDependencies 安装在本地即可,Slidev 会自动处理好编辑器所需的类型。以 SPA 形式部署时,这些类型也会一并打包用于静态托管。
额外类型
Slidev 会扫描幻灯片中所有 Monaco 代码块,自动导入所用库的类型。如果有遗漏,你可以显式指定需要导入类型的包:
```md --- monacoTypesAdditionalPackages: - lodash-es - foo --- ```
自动类型获取
你也可以通过设置以下 headmatter,改为从 CDN 加载类型:
```md --- monacoTypesSource: ata --- ```
该功能由 @typescript/ata 驱动,完全在客户端运行。
配置主题
从 v0.48.0 起,Monaco 会复用你在 Shiki 配置文件中设置的主题(由 @shikijs/monaco 实现),无需额外操心,且能与其余代码块保持一致的风格。
配置编辑器
v0.43.0 起可用
如需自定义 Monaco 编辑器,可以传入符合 Monaco IEditorOptions 定义的 editorOptions 对象:
```md ```ts {monaco} { editorOptions: { wordWrap: 'on' } } console.log('HelloWorld') ``` ```
如果想让这些选项应用到所有 Monaco 实例,也可以在 defineMonacoSetup 函数中返回它们:
./setup/monaco.ts
```ts import { defineMonacoSetup } from '@slidev/types'
export default defineMonacoSetup(() => { return { editorOptions: { wordWrap: 'on' } } }) ```
禁用
从 v0.48.0 起,Monaco 编辑器默认启用,且只在实际使用时才会打包。如果想禁用它,可以在幻灯片的 frontmatter 中把 monaco 设为 false:
```yaml --- monaco: false # 也可以设为 `dev` 或 `build`,按条件启用 --- ```
严格模式
v0.52.0 起可用
默认情况下,Monaco 可运行代码在严格模式("use strict")下执行。如果你的代码依赖非严格模式行为,可以关闭它:
```yaml --- monacoRunUseStrict: false --- ```
配置代码运行器
要配置 Monaco Runner 的代码执行方式,或添加对自定义语言的支持,请参阅「配置代码运行器」。