Docuo VSCode 扩展

为 MDX 文档编写提供增强支持的 VSCode 扩展。

本地调试

1. 安装依赖

cd vscode-extension
npm install

2. 编译代码

# 一次性编译
npm run compile

# 监听模式（推荐开发时使用）
npm run watch

3. 启动调试

方法一：使用 VSCode 调试面板

1. 用 VSCode 打开 vscode-extension 目录
2. 按 F5 或点击左侧调试图标
3. 选择 Run Extension 配置
4. 会自动打开一个新的 VSCode 窗口（Extension Development Host）

方法二：手动启动

1. 先运行 npm run watch 保持编译
2. 按 F5 选择 Run Extension (No Build) 配置

4. 调试技巧

• 修改代码后，在调试窗口按 Cmd+R（Mac）或 Ctrl+R（Windows）重新加载扩展
• 使用 console.log 输出会显示在主窗口的 Debug Console 中
• 调试窗口的 Help > Toggle Developer Tools 可查看 Webview 日志

项目结构

vscode-extension/
├── src/
│   ├── extension.ts      # 扩展入口
│   ├── functions/        # CodeLens、命令等功能
│   ├── utils/            # 工具类（OSS上传等）
│   ├── view/             # Webview Provider
│   └── webview/          # 侧边栏 React 应用
├── out/                  # 编译输出
├── resources/            # 静态资源
└── package.json

常用命令

注意事项

• 调试扩展功能时用 npm run watch
• 调试侧边栏 Webview 时需要同时运行 npm run dev
• 发布前需运行 npm run build && npm run compile