最近写项目交接文档我又踩了一遍老坑。本地用 VS Code 写 Markdown 体验是不错但一涉及到公式、流程图预览插件就各种不兼容 teammate 用 Mac我用 Windows换台电脑格式就偏最后要导 PDF 给甲方又得折腾 Pandoc 和 LaTeX字体还总缺失。一来二去半天没了。这次我干脆把整套流程迁到了浏览器里试了两周居然意外顺手。一、我需要的其实就三件事写技术文档这件事拆开来不外乎一个能实时预览的 Markdown 编辑器支持代码高亮、公式、Mermaid 流程图导出样式可控的 PDF方便发给别人。之前我本地装了三四个插件才凑齐这些功能现在发现有个在线 Markdown 编辑器直接把这些打包了。打开页面左边写源码右边实时渲染所见即所得。代码块会自动高亮写架构图的时候直接插 Mermaid 语法不需要再切到别的画图工具。我这张图里其实是一份项目梳理文档表格、列表、代码块混排右侧预览没有错位。对于写接口说明或者部署手册来说这种同步预览能少返工很多次。二、从 Markdown 到 PDF我之前卡在哪本地转 PDF 最让我头疼的是排版不可控。比如用浏览器打印页边距忽大忽小用 Pandoc 转中文字体要单独配置用某些在线转换公式又变图片分辨率一塌糊涂。这次我试了一个专门的 Markdown 转 PDF 工具可以调主题、纸张大小、方向和页边距字号也能拉滑块改。关键是公式和代码高亮能完整保留不会转成低清图。设置完直接点导出出来的 PDF 就是标准 A4放进邮件附件或者项目文档库都够用。三、一个具体的写文档流程我现在写技术文档大致是这样的先在在线编辑器里把大纲和正文敲完边写边看效果遇到复杂流程就插入 Mermaid 代码实时渲染出来需要给外部人员时整篇粘贴到 Markdown 转 PDF 工具里选个主题、调下边距导出即可。整个流程没有本地依赖换电脑、换系统都不影响。上次我在客户现场临时改文档直接登录账号就能接着写不用再配环境。四、适合什么场景这套流程我觉得比较适合接口文档、部署手册这类需要频繁修改的技术文档需要插入公式或流程图的方案文档最后要输出 PDF 归档或外发的场景。当然如果你写博客用静态站点生成器或者团队有统一的文档平台那另说。但对个人和小团队来说浏览器里完成 “写 → 看 → 导出” 整条链路确实省了不少配置时间。五、顺便提一下这两个工具我是在工具派上找到的地址是 https://gjupai.com/ 。同一个站里还有 JSON 格式化、SQL 格式化、表格数据清洗之类的小工具写文档时顺手查点数据也挺方便。项目地址https://gjupai.com/最后补充一句在线工具的好处是即用即走但重要文档还是记得本地备份一份。我一般会同时导出 Markdown 源文件和 PDF双保险。
写技术文档时,我把Markdown编辑和PDF导出都搬到了浏览器
发布时间:2026/7/10 21:17:24
最近写项目交接文档我又踩了一遍老坑。本地用 VS Code 写 Markdown 体验是不错但一涉及到公式、流程图预览插件就各种不兼容 teammate 用 Mac我用 Windows换台电脑格式就偏最后要导 PDF 给甲方又得折腾 Pandoc 和 LaTeX字体还总缺失。一来二去半天没了。这次我干脆把整套流程迁到了浏览器里试了两周居然意外顺手。一、我需要的其实就三件事写技术文档这件事拆开来不外乎一个能实时预览的 Markdown 编辑器支持代码高亮、公式、Mermaid 流程图导出样式可控的 PDF方便发给别人。之前我本地装了三四个插件才凑齐这些功能现在发现有个在线 Markdown 编辑器直接把这些打包了。打开页面左边写源码右边实时渲染所见即所得。代码块会自动高亮写架构图的时候直接插 Mermaid 语法不需要再切到别的画图工具。我这张图里其实是一份项目梳理文档表格、列表、代码块混排右侧预览没有错位。对于写接口说明或者部署手册来说这种同步预览能少返工很多次。二、从 Markdown 到 PDF我之前卡在哪本地转 PDF 最让我头疼的是排版不可控。比如用浏览器打印页边距忽大忽小用 Pandoc 转中文字体要单独配置用某些在线转换公式又变图片分辨率一塌糊涂。这次我试了一个专门的 Markdown 转 PDF 工具可以调主题、纸张大小、方向和页边距字号也能拉滑块改。关键是公式和代码高亮能完整保留不会转成低清图。设置完直接点导出出来的 PDF 就是标准 A4放进邮件附件或者项目文档库都够用。三、一个具体的写文档流程我现在写技术文档大致是这样的先在在线编辑器里把大纲和正文敲完边写边看效果遇到复杂流程就插入 Mermaid 代码实时渲染出来需要给外部人员时整篇粘贴到 Markdown 转 PDF 工具里选个主题、调下边距导出即可。整个流程没有本地依赖换电脑、换系统都不影响。上次我在客户现场临时改文档直接登录账号就能接着写不用再配环境。四、适合什么场景这套流程我觉得比较适合接口文档、部署手册这类需要频繁修改的技术文档需要插入公式或流程图的方案文档最后要输出 PDF 归档或外发的场景。当然如果你写博客用静态站点生成器或者团队有统一的文档平台那另说。但对个人和小团队来说浏览器里完成 “写 → 看 → 导出” 整条链路确实省了不少配置时间。五、顺便提一下这两个工具我是在工具派上找到的地址是 https://gjupai.com/ 。同一个站里还有 JSON 格式化、SQL 格式化、表格数据清洗之类的小工具写文档时顺手查点数据也挺方便。项目地址https://gjupai.com/最后补充一句在线工具的好处是即用即走但重要文档还是记得本地备份一份。我一般会同时导出 Markdown 源文件和 PDF双保险。