提到 Markdown 编辑器,很多人会想到 Typora。写几行标题、插一段代码,马上就能看到排版效果,这种方式很适合记笔记、写技术文档。
不过,选编辑器时,也可以从自己平时写的内容出发。只写文字和代码,要求相对简单;文档里有流程图、公式、本地截图,最后还要给同事发 PDF,就得把这些环节也考虑进去。
拿一份接口说明来说:前面写参数,中间解释调用过程,后面放返回示例。正文和图能在一起修改,长文档能通过大纲找到章节,写完能按需要交付,这几件事比列出一长串格式按钮更有用。
文档里的图,也可以直接写出来
几步调用关系可以用 Mermaid 表达:
flowchart LR
A[客户端] --> B[校验参数]
B --> C[查询订单]
C --> D[返回结果]
在支持 Mermaid 的编辑器里,这段代码会变成流程图。后面加一个步骤,直接修改文字和连线即可,图的内容也跟着保存在 Markdown 里。
公式同样可以用文本语法写,例如:
平均耗时:$\bar{t} = \frac{1}{n}\sum_{i=1}^{n} t_i$
所以,如果平时会写这些内容,挑编辑器时可以实际放一段进去,看看编辑和显示是否符合自己的习惯。
还有一款可以试试的编辑器
这些场景,在 Muse Nexus 的 Markdown 工具里也能完成。它有阅读(混合编辑)和源码两种模式,支持 Mermaid、数学公式、本地图片和文档大纲。
这是官网的演示截图,文档内容为示例数据。
写正文时,可以在混合编辑模式里看排版;要改图片路径、链接或代码块标记,再切到源码。两种模式对应的是同一份文档,按当前操作选择即可。
长文档右侧有大纲,点击标题定位章节。还提供专注模式和打字机模式,适合写作时按自己的习惯调整界面。
外观也可以换。Muse Nexus 有多款主题,官网能看到预览;选择时可以一起看看正文、代码和侧栏的显示,而不只是背景图。
本地图片和导出,是另一个实际需求
图片可以从工具栏插入。文档、草稿和本地图片留在电脑上,账号不负责同步文档正文。
写完后可以保存 Markdown、导出 HTML,或者使用“打印 / PDF”。如果对方还要继续编辑,就发送 Markdown 和引用的图片;如果只需要阅读,可以发 PDF。
这里有个容易忽略的细节:本地图片在自己电脑上显示正常,不代表单独发送 .md 文件后,对方也能看到。分享源文件时要带上图片;分享 PDF 时,则在导出后检查一下分页和图表。
适不适合,还是看你平时怎么写
如果你希望在一个编辑窗口里写正文、看公式和流程图,再保存到本地或导出,可以把它加入试用名单。
Muse Nexus 同时包含 API 调试和数据库等工具,Markdown 是其中一个独立工具窗口。已有习惯用的编辑器,也完全可以拿同一份文档试试,再判断是否值得换。
补充一下,Muse Nexus 是我正在做的项目。Windows 版已上架 Microsoft Store,macOS 版还在完善和测试;首次登录有一个月全工具试用,之后完整功能需要会员。
界面截图、主题和安装入口在 官网 lingban.xyz。