Markdown Live
|
| 你想做的事 | Markdown Live 的方式 |
|---|---|
| 直接写、直接改 | 正文、标题、列表、引用、任务清单;选区工具栏与 / 插入菜单 |
| 按需查看源码 | 段落内展开 CodeMirror,或定位到原生 Markdown 编辑器 |
| 整理技术笔记 | KaTeX 公式、Mermaid 图表、GFM 表格、脚注,以及 Pandoc Figure / Caption 容器 |
| 放入图片 | 粘贴截图或拖入图片,自动写入文档旁的资源目录并插入相对路径 |
| 在长文中移动 | 章节大纲、全文查找替换、专注模式、字词统计与阅读进度 |
| 调整阅读尺寸 | Ctrl + 滚轮缩放正文至 50%–200%,工具栏保持原大小 |
| 继续原有工作流 | VS Code 原生保存与撤销;外部修改同步,重叠冲突保留待恢复草稿 |
完整操作、快捷键和四项配置见使用指南。
文件仍由你掌握
- 普通 Markdown:不引入专有文档格式。局部文本补丁尽量保留未编辑部分的标记、空行、注释、引用定义和换行格式。
- 编辑可离线:字体、脚本、公式与图表渲染库随扩展打包。文档引用的远程图片仍需要网络。
- 图片放在文档旁:默认保存到
assets/<文档名>/;Remote WSL 中写入 WSL 文件系统。 - 冲突保留草稿:非重叠修改尝试合并,重叠时停止提交,并提供比较与恢复入口。
当前边界
Markdown Live 面向笔记、技术文档和研究记录。表格遵循 Markdown 的结构,不支持合并单元格;不提供 PDF / Word 导出、BibTeX / Zotero 集成、图表拖拽设计。Pandoc 容器支持内容编辑及 Figure / Caption 排版,不读取 Word 模板样式。
自动化验证记录见 VALIDATION.md。实体中文输入法验收仍待完成;Windows 与 Remote WSL 的已验证版本和范围分别记录。
开发与参与
需要 Node.js 22+、npm 与 VS Code 1.96+。
git clone https://github.com/zJay26/vscode-markdown-live.git
cd vscode-markdown-live
npm ci
npm run dev
npm run dev 打开独立浏览器预览;它使用浏览器本地存储,不写入工作区文件。完整构建、测试和 VSIX 打包方法见开发指南。
TypeScript · VS Code Custom Editor · Milkdown / ProseMirror · CodeMirror 6 · KaTeX · Mermaid
| 文档 | 内容 |
|---|---|
| 使用指南 | 安装、迁移、快捷键、兼容范围与配置 |
| 开发指南 | 本地开发、构建、测试和项目结构 |
| 发布与更新 | 提交推送、发布商店版本与本地更新 |
| 贡献指南 | 提交问题、参与修改与验证要求 |
| 验证记录 | 已执行的检查、环境和未验证部分 |
| 更新记录 | 每个版本的变化 |
欢迎通过 Issues 提交可复现的问题和具体使用场景。
许可与致谢
采用 MIT License。第三方依赖遵循各自许可证,生产包保留许可声明。感谢上述开源组件提供编辑、源码控制与排版基础。
Made by zJay
也可以看看 zMatrix · 内容工作台 与 zClip · 本地视频剪辑。
