Remons Markdown Editor(VSCode 插件)
基于 React 组件 remons-markdown-editor 的 VSCode Markdown 可视化 自定义编辑器。
在编辑器工具栏 + 实时预览中编写 Markdown,内容自动同步回底层 .md 文件,并复用 VSCode 原生的保存 / 撤销 / 热退出能力。
使用
- 打开任意
.md / .markdown 文件,默认进入只读预览(深色主题);
- 点击预览左下角的铅笔图标(或标题栏铅笔图标),切换到可视化编辑器(CodeMirror 编辑 + 实时预览);
- 点击编辑区左下角的眼睛图标(或标题栏眼睛图标),回到只读预览;
- 太阳 / 月亮图标(或标题栏主题图标)切换编辑与预览的深浅配色;
- 面板图标按钮隐藏右侧实时预览,让编辑器占满整个面板,再次点击恢复;
- 需要直接改源码时,点击标题栏
</> 图标,或执行命令 Remons Markdown: 以文本编辑器打开,切换到 VSCode 文本编辑器;在文本编辑器中点击标题栏眼睛图标可再打开可视化编辑器。
特性
- Markdown 可视化编辑 + 实时预览,内容自动同步回文件,保存 / 撤销 / 热退出由 VSCode 托管;
- 深色(默认)/ 浅色 / 跟随 VSCode 三种主题模式;
- 沉浸式编辑(隐藏预览)、只读预览、文本编辑器三态可随时切换;
- highlight.js 全量语言高亮,内置本地 KaTeX,公式离线可渲染;Mermaid 图表由组件库运行时从 npmmirror CDN 加载(需联网)。
默认模式可通过设置 remonsMarkdownEditor.defaultMode 调整:preview(默认,只读预览)/ edit(可视化编辑);主题、预览开关与沉浸式可用 remonsMarkdownEditor.theme / .showPreview / .immersive 配置默认值。
如需让 .md 默认恢复为 VSCode 文本编辑器,可在设置中将
workbench.editorAssociations 的 *.md 关联为 "default",或在文件上右键 → 打开方式… → 选择文本编辑器。
开发
npm install --registry=https://registry.npmmirror.com
npm run build # esbuild 产出 dist/
npm run watch # 监听构建
npx @vscode/vsce package --no-dependencies # 打包 .vsix
按 F5 启动扩展开发宿主进行调试。
详细设计、依赖调研与实现说明见 docs/技术文档.md。
| |