Mac上一款超级简单易用的所见即所得 Markdown 查看器,
md-preview是傻瓜式Python工具,一句命令把Markdown文档变成带Bootstrap美颜的网页,零配置支持主题切换和代码高亮,适合技术写作和报告预览。
将鼠标悬停.md在图标上(或将 Markdown 预览设置为默认处理程序),即可获得清晰、可滚动的预览,其中包含真实的文档大纲——无需 Electron,也无需浏览器标签页。
特征
- 原生渲染——由swift-markdownWKWebView支持的管道,带有标题锚点和链接处理。
- 美人鱼图——围栏式mermaid代码块在应用程序和快速查看预览中均以图表形式呈现,使用捆绑渲染器,因此预览可以在离线状态下工作,无需 CDN 请求。
- 数学公式——LaTeX 行内公式 ( $x_1 + x_2$)、显示公式 ( $$\int_0^1 x^2\,dx$$) 和带围栏的math公式块使用捆绑的 KaTeX 进行渲染。选择已渲染的公式并复制,即可获得原始 LaTeX 源代码(通过官方copy-tex扩展)。
- 文档大纲——侧边栏目录与标题相对应;点击即可跳转。
- 检查器面板——带有文件元数据的可切换侧边栏。
- 文档内搜索——工具栏搜索字段加上标准⌘F/ ⌘G/⌘⇧G用于下一个/上一个匹配项。
- 打开方式— 无需离开预览即可切换到您的实际编辑器(VS Code、Cursor、Zed、Sublime、BBEdit、Nova、CotEdit、TextMate、MacVim、Xcode、TextEdit)。列表会筛选出已声明为 Markdown 编辑器的应用程序,并记住您的选择。
- 分享 = 复制源文件— 分享工具栏会将 Markdown 文本本身提供给选择器,因此“复制”会将原始源文件写入剪贴板(非常适合粘贴到 ChatGPT / Claude 中),而邮件、消息和笔记则会在正文中获取内容,而不是文件 URL。
- Quick Look 扩展程序.md——无需启动应用程序,即可在 Finder 空格键、Spotlight 和邮件附件中进行系统范围的预览。
- 默认处理程序.md—在首次启动时,主动注册自身为默认打开程序。
这个工具就像文档界的傻瓜相机
你写Markdown文档的时候,是不是觉得它长得像程序员的黑话本。一堆井号和中括号,发给老板看,老板以为你在写密码。md-preview这个工具干的事特别简单,把你写的素颜文档一键加上美颜滤镜,变成正经网页。
它就是个命令行工具,你敲一句话,它自动打开浏览器,给你看成品。整个过程比你泡方便面还快,因为泡面还得等水烧开。
安装就两步,比下馆子点菜还简单
你先得把它的代码从网上拽下来。用git clone那句命令,或者直接下载压缩包都行。然后打开终端,cd进那个文件夹,敲pip install点。就这一句,剩下的它自己搞定。
这里的点代表当前文件夹,意思是让Python把这里的代码装进你的电脑。整个过程不会超过三十秒,比你在奶茶店排队快多了。
预览文件只需要敲一行命令,跟发朋友圈一样容易
装好之后,你随便找个Markdown文件试试。在终端里敲md-preview空格然后文件名,比如md-preview README点md。回车之后,它会自动打开你的默认浏览器,你的文档已经变成排版精美的网页了。
这个过程背后做了三件事。第一,它把Markdown语法转成HTML标签。第二,它给这个HTML穿上Bootstrap的衣服。第三,它启动一个临时网页服务器,让浏览器能访问到。你什么都不用管,它全包了。
换主题更简单,加个参数就能从白天切到黑夜
你觉得默认的白底黑字太普通,想要暗黑风格。那就加个参数,md-preview空格文件名空格--style darkly。Darkly是暗黑主题的名字,一敲回车,整个页面立刻变成黑底白字,代码块也变成高亮风格。
它还内置了其他主题。Flatly是清爽商务风,Cyborg是赛博朋克风,Superhero是漫画英雄风。每个主题都是整套UI一起换,不是只换个背景色就糊弄你。你可以根据心情随便切,就跟换手机壁纸一样简单。
Bootstrap让它长得像大厂产品文档,不像草稿本
普通Markdown预览工具的问题是什么。标题长一个样,表格长一个样,代码块又长另一个样,整个页面风格乱得像拼夕夕装修队干的活。md-preview直接用Bootstrap这个前端框架统一所有样式。
Bootstrap是推特公司开源的UI库,它给标题、段落、表格、按钮都定好了规范。md-preview把你的文档塞进这个规范里,标题自动变成Bootstrap的大字风格,表格自动带上斑马条纹,引用块变成浅色气泡框,代码块变成带复制按钮的卡片。
你看到的最终效果就像一个正经技术文档网站的页面,而不是记事本截图。
代码块带了复制按钮,不用再手动框选
程序员写文档最烦的事是什么。复制代码的时候鼠标总是多选一行或者少选一行。md-preview在每个代码块的右上角自动加了一个复制按钮,你点一下,代码就进剪贴板了。
这个按钮是纯前端实现的,不依赖任何网络请求。就算你断网了,按钮照样好用。它用的是浏览器原生的复制API,安全又快速。你写教程的时候,读者复制示例代码再也不用缩手缩脚了。
主题系统不是糊弄人的,整个页面一起换
很多工具所谓的换主题只换代码块的颜色,其他地方还是灰扑扑的默认白底。md-preview的每个主题都是完整的一套配色和样式方案。
暗黑主题Darkly会把整个页面的背景、文字、表格、按钮、引用块全变成暗色调。代码块的高亮配色也会跟着调整,保证在黑底上能看清楚。这就跟你手机开了夜间模式一样,所有APP界面一起变黑,不会留一个刺眼的白框在那。
零配置是它最狠的地方,不用写任何配置文件
你用其他文档工具的时候,通常要写一大坨配置。比如指定网站标题、设置导航栏菜单、选主题颜色、配置部署路径等等。很多时候你还没开始写文档,先折腾半天配置文件。
md-preview完全没有配置文件这一说。你装好就能用,预览命令不需要任何初始化步骤。它甚至连默认主题都不需要你选,装完直接给你一个干净清爽的默认样式。这种无脑用的体验,就像打开电视机就有画面,不用先设置机顶盒。
纯Python写的,不用学前端也能改
这个工具的代码全是Python,没有一行JavaScript构建脚本。你想改它的行为,直接改Python文件就行。比如你想增加一个新主题,找到它加载主题的那段代码,加个判断就完事。
它的内部逻辑很简单。读取Markdown文件内容,用Python的Markdown库转成HTML字符串,然后把HTML字符串塞进一个带Bootstrap链接的模板里,最后写进临时文件并打开浏览器。整个流程不超过五十行核心代码,你花十分钟就能看明白。
本地运行不依赖网络,开会没网也能展示
你把文档带到没有WiFi的会议室,打开这个工具预览,它照样能完美渲染。因为它把Bootstrap的CSS文件缓存到了本地,不需要去CDN下载。代码高亮的样式也是自带的,不需要请求外网。
这就很有用了。比如你在飞机上赶报告,或者去客户那里面试演示,现场网络状况谁都说不好。md-preview完全不依赖外网,你只要有电有电脑就能干活。
响应式布局,手机打开也不会乱码
你把预览链接发给自己,用手机浏览器打开看看。页面会自动适应手机屏幕,文字大小合适,表格可以左右滑动,代码块也不会撑破屏幕。这是Bootstrap自带的响应式系统在干活。
Bootstrap的栅格系统会根据屏幕宽度自动调整布局。在电脑上是两栏或者三栏,在手机上自动变成一栏竖着排。按钮也会变大一点,方便你用手指按。你写文档的时候不用特意照顾手机用户,工具帮你兜底。
它适合写技术文档的人,比如README和博客
你维护一个开源项目,README点md写了很长,但在GitHub网页上看总感觉乱糟糟的。用md-preview预览一下,你会发现标题层级清晰,表格对齐整齐,代码块配色舒服。这时候你再去调整文档结构,心里就有底了。
写技术博客也是。很多博客平台支持Markdown,但实时预览功能很弱。你可以在本地用md-preview写完再粘贴上去,保证格式不会乱。它还比VSCode的预览窗口好看一百倍,写起来更有动力。
它也适合写报告的学生和打工人
你做个AI实验报告,里面有模型对比表格、代码示例、数学公式。用普通文本编辑器写完发给老师,老师可能看都不想看。用md-preview渲染成网页,截个图放PPT里,或者直接打印成PDF交上去,整个报告的档次立刻上去。
数据分析报告也一样。你用Jupyter Notebook做完分析,导出成Markdown格式,再用md-preview加上Bootstrap样式,就变成了带图表和代码的数据看板。虽然不是交互式的,但做静态报告完全够用。
它不适合做复杂网站,别拿它当WordPress用
你如果想做个带用户登录、评论系统、商品支付的公司官网,别用这个工具。它只是一个渲染器,不是网站生成器。它不会帮你生成导航栏菜单栏,也不会帮你部署到服务器。
它的定位很清晰。预览你写好的Markdown文档,让它临时变好看,方便你看效果或者给别人展示。你想永久发布到网上,得把生成的HTML源码复制出来,自己去托管。
和VSCode预览的区别是更好看
VSCode自带的Markdown预览功能很方便,按Ctrl加Shift加V就能打开。但它的问题是样式太朴素,标题和正文区别不大,表格看不出行列关系,代码对比度低。
md-preview就是来解决这个丑的问题的。同样一段Markdown,VSCode预览出来像Word安全模式,md-preview预览出来像苹果官网的文档页面。而且md-preview也是完全免费的,你多打一行命令换个皮肤,不亏。
和浏览器插件的区别是样式统一
Chrome里有不少Markdown预览插件,你直接把点md文件拖进浏览器就能看。但它们每个用的渲染引擎不一样,有的用GitHub的样式库,有的用简单正则替换,出来的页面风格五花八门。
md-preview锁定了Bootstrap作为唯一样式基础。不管你在哪台电脑上运行,出来的视觉效果是一致的。你不用担心这台电脑上表格有边框,那台电脑上表格没边框这种破事。
和文档生成框架的区别是零配置
Docusaurus和VuePress这类工具功能强大,能生成完整的文档网站,带侧边栏、搜索、版本切换。但它们需要你写配置文件,学习它的目录结构,有时候还要写React组件。
md-preview就一个命令,没有这些东西。它不生成静态网站,只是预览单个文件。你写文档的时候用它边走边看,写完了再决定要不要用复杂框架。它属于轻量辅助工具,不上大炮打蚊子。
优点总结一下就两个词,快和好看
快体现在不用配置、不用学习、一秒出图。你下载加安装加预览,全程不超过两分钟。好看体现在Bootstrap统一风格、代码块带复制按钮、主题一键切换。你写的还是原来那个纯文本,但看起来像花了一小时排版。
这个工具不搞花里胡哨的特效,没有淡入淡出动画,没有视差滚动。它就是老老实实把你的文字和代码最舒服地摆出来。这种风格在技术文档领域特别受用,因为读者只想快速找到信息,不想看炫技。
缺点也很诚实,它只能看不能编
你打开预览之后只能看,不能编辑。想改内容得回到你的文本编辑器,改完保存,再刷新浏览器才能看到新效果。这个流程不像那些所见即所得的编辑器实时反馈。
另外它不支持复杂的交互组件。你不能在里面嵌一个实时图表,也不能嵌入视频播放器。它就是静态网页,适合文字和代码展示。如果你需要这些高级功能,得去找别的工具。
项目作者是个实用主义者
从设计思路能看出来,作者肯定被复杂的文档工具折磨过。所以才做出这么一个工具:遵循最小惊讶原则,你猜它怎么用,它其实就是那么用。没有惊喜也没有惊吓。
这种工具在开源社区特别受欢迎。因为大家只是想解决一个具体的小问题,不想升级成架构师。你把这个问题解决得干净利落,比写一万行文档更有说服力。