终端用户一直在寻找更好的方式来预览 Markdown 文件。markless 用不到 110 行核心代码,实现了一个支持图片渲染的终端 Markdown 查看器。

项目概览

属性内容
GitHubjvanderberg/markless
Stars107
语言Rust
特点终端图片渲染、轻量、快速
最后更新约 3 周前

它解决了什么问题

在终端中查看 Markdown 文件通常面临两个选择:

  1. 使用 catless 直接查看原始文本,失去格式和图片
  2. 启动浏览器或专门的 Markdown 编辑器,流程繁琐

markless 提供了第三种方案:直接在终端中获得接近完整的 Markdown 阅读体验,包括图片显示。

核心特性

终端图片渲染

markless 支持通过 iTerm2 和 Kitty 终端的图像协议直接在终端中显示图片。这意味着你无需离开终端,就能看到文档中的配图。

轻量设计

项目代码量极小,编译后的二进制文件体积控制在合理范围内,启动速度极快。对于需要频繁查看文档的开发者来说,这种响应速度很重要。

Markdown 完整支持

基于成熟的 Markdown 解析库,markless 能够正确处理标题、列表、代码块、表格等常见格式,输出排版清晰的终端显示效果。

语法高亮

代码块会按照语言类型进行语法高亮,提升代码片段的可读性。

快速开始

# 克隆仓库
git clone https://github.com/jvanderberg/markless.git
cd markless

# 编译安装
cargo build --release

# 使用
./target/release/markless README.md

工具对比

工具Stars特点
glow39k+功能丰富,支持主题
mdfried307终端图片渲染,Rust 编写
markless107极简设计,支持图片,Rust

glow 是目前最受欢迎的终端 Markdown 查看器,功能完善但体积较大。mdfried 与 markless 类似,都专注于图片渲染,但 markless 的代码更加精简。如果你追求极致的简洁,markless 值得尝试。

适用场景

  • 在 SSH 服务器上快速查看 Markdown 文档
  • 终端工作流中快速预览 README 文件
  • 需要查看包含截图或图表的技术文档
  • 希望在终端中获得一致阅读体验的开发者

使用限制

  • 图片渲染需要 iTerm2 或 Kitty 等支持终端图像协议的终端
  • 项目尚处于早期阶段,功能相对基础
  • 不支持鼠标交互或复杂的文档导航

总结

markless 证明了终端工具不需要庞大复杂才能解决问题。107 个 star 对它来说或许只是开始,但这个数字也准确反映了它的定位:一个专注做好一件事的小工具。如果你厌倦了在终端和浏览器之间来回切换来查看 Markdown,markless 值得一试。


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