markless 是一个专为终端设计的 Markdown 查看器,它解决了开发者在 SSH 环境或无 GUI 服务器上阅读文档的痛点——不需要离开终端,就能看到排版美观、甚至包含图片的 Markdown 文件。

项目概览

属性内容
GitHubjvanderberg/markless
Stars100
语言Rust
特点终端图片渲染、Kitty/iTerm2 协议支持
最后更新10天前

它解决了什么问题

在终端里阅读 Markdown 文档一直是个尴尬的体验:

  • cat 命令直接输出原始 Markdown 语法,可读性差
  • 传统工具如 mdvglow 虽然能渲染格式,但遇到图片就无能为力
  • 在远程服务器上,没有浏览器可用,查看带截图的 README 变得很麻烦

markless 的核心价值在于:它让终端真正「看懂」Markdown,包括其中的图片。

核心特性

图片渲染支持

markless 支持多种终端图形协议:

  • Kitty Graphics Protocol:目前最成熟的终端图形方案
  • iTerm2 Inline Images:macOS 用户熟悉的协议
  • Sixel:老牌终端图形标准,兼容性好

这意味着无论你是用 Kitty、iTerm2、WezTerm 还是 Ghostty,都能在终端里直接看到 Markdown 中的图片。

实时预览

markless 会监听文件变化,保存 Markdown 后自动刷新显示,写作体验接近桌面端的实时预览编辑器。

轻量快速

作为 Rust 项目,markless 的启动速度和渲染性能都很出色。在大型文档(数千行)上的表现依然流畅。

简洁的交互

  • j/k 或方向键滚动
  • q 退出
  • 鼠标滚轮支持(在支持的终端中)

快速开始

# 从 crates.io 安装
cargo install markless

# 或使用预编译二进制文件
# 从 GitHub Releases 下载对应平台的可执行文件

# 查看 Markdown 文件
markless README.md

# 实时预览模式
markless --watch docs/guide.md

对比其他工具

工具Stars图片支持特点
glow15k+颜值高,支持主题
mdv3k+Python 编写,易扩展
mdcat2k+⚠️ 有限功能丰富但配置复杂
markless100专注图片渲染,简洁快速

markless 的定位很明确:它不是功能最全的 Markdown 查看器,而是「在终端里看带图片的 Markdown」这个问题的最佳解决方案。

适用场景

远程服务器文档阅读

SSH 到服务器后,经常需要查看项目文档或日志说明。markless 让你无需下载文件到本地就能完整阅读。

CLI 工具文档预览

如果你正在开发一个命令行工具,可以用 markless 在终端里预览 README 的渲染效果,确保文档格式正确。

无图形界面环境

Docker 容器、WSL、云端开发机——任何没有浏览器的环境都是 markless 的用武之地。

使用注意

  • 图片渲染需要终端支持相应的图形协议(Kitty、iTerm2、WezTerm 等)
  • 对于不支持的终端,markless 会优雅降级为纯文本模式
  • 项目目前处于早期阶段(v0.1.x),API 可能会有变动

总结

markless 是一个小而美的工具,它填补了终端 Markdown 查看器在图片渲染方面的空白。100 个 Star 的背后是一个解决真实问题的实用项目。如果你在终端里花的时间不少,值得试一试。

属性内容
仓库https://github.com/jvanderberg/markless
许可证MIT
语言Rust
维护者@jvanderberg