在终端里编辑 Markdown 文件时,你是否经常需要在编辑器和浏览器之间来回切换?markln 把这个流程简化为一步——在终端里直接编辑并实时预览。

项目概览

属性内容
GitHubxqtr/markln
Stars51
语言Python
特点终端内实时预览、双窗格布局、轻量级
最后更新4天前

它解决了什么问题

写 Markdown 的标准工作流通常是这样:

  1. 在编辑器里写内容
  2. 保存文件
  3. 切换到浏览器查看渲染效果
  4. 发现问题,回到编辑器修改
  5. 重复步骤 2-4

markln 把这个循环压缩到一个终端窗口内完成。左侧编辑,右侧实时预览,无需离开命令行环境。

核心特性

双窗格实时预览 界面分为左右两部分:左侧是编辑区,右侧是渲染后的预览。光标移动时预览同步更新,没有延迟感。

纯终端环境 不依赖图形界面,SSH 到远程服务器也能用。适合在 VPS、容器或无桌面环境的工作场景。

轻量依赖 基于 Python 标准库和常见终端工具构建,安装简单。不需要 Node.js 或复杂的构建流程。

类 Vim 快捷键 支持方向键移动光标,同时提供 Vim 风格的导航快捷键(h j k l),减少手指移动距离。

快速开始

# 克隆仓库
git clone https://github.com/xqtr/markln.git
cd markln

# 安装依赖
pip install markdown

# 启动编辑
python markln.py your-file.md

启动后会进入一个双窗格界面:

  • Tab 键切换焦点(编辑区 / 预览区)
  • 在预览区可以用方向键滚动浏览
  • Ctrl+S 保存,Ctrl+Q 退出

同类工具对比

工具Stars特点
Glow31k+只读渲染,不支持编辑
mdv3.8k只读查看器,样式丰富
Tusk7支持编辑,基于 Textual
markln51编辑+实时预览,双窗格

Glow 和 mdv 专注于渲染展示,如果你想在终端里直接修改内容,markln 是目前少有的选择之一。Tusk 功能类似但基于 Textual 框架,markln 的实现更轻量。

适用场景

  • 远程服务器文档编写:SSH 登录后直接编辑,无需配置图形环境
  • 快速笔记:在终端里随手写几行,实时确认格式
  • README 编写:在提交前最后检查一遍渲染效果
  • 低资源环境:老旧机器或容器中也能流畅运行

注意事项

  • 目前处于早期开发阶段(v0.1.x),功能相对简单
  • 预览基于 Python 的 markdown 库,不支持所有 GitHub Flavored Markdown 扩展
  • 大规模文件(几千行)的性能表现未经充分测试
  • GPL v3 许可证,商业项目需留意合规性

总结

markln 填补了终端 Markdown 工具的一个空白:在命令行里直接编辑并实时预览。51 个 Star 说明它还不够知名,但如果你经常在 SSH 会话或容器里写文档,这个小工具可能刚好解决你的痛点。

项目还在活跃开发中,最近 4 天前有更新。如果你对这个方向感兴趣,可以去 GitHub 点个 Star 支持一下。

属性内容
仓库https://github.com/xqtr/markln
许可证GNU General Public License v3.0
语言Python
维护者@xqtr