Repolode
charmbracelet

charmbracelet/glow

在终端中渲染和浏览 Markdown 文件的命令行工具,支持样式化显示。

Star
27,741
Fork
890
未关闭 Issue
256
最近提交
15天前

这是什么?

Glow 是一款终端 Markdown 阅读器。不带参数运行时会打开浏览界面,列出当前目录及子目录(若位于 Git 仓库中则搜索整个仓库)的本地 Markdown 文件,并以类似 less 的快捷键进行阅读。

它也可以直接在命令行中渲染文档。输入源可以是本地文件、标准输入、GitHub 或 GitLab 仓库路径以及 HTTP 链接。渲染时会根据终端背景色自动选择深色或浅色样式,也支持使用自定义 JSON 样式表,并可设置换行宽度或通过分页器显示。

常用参数可以写入 YAML 配置文件保存。项目使用 Go 编写,可通过 macOS、Linux、Windows 和 BSD 上的常见包管理器安装。

核心功能

  • 01在终端界面中浏览和阅读本地 Markdown 文件。
  • 02支持从文件、标准输入、GitHub/GitLab 路径或网址渲染 Markdown。
  • 03根据终端背景色自动选择深色或浅色样式。
  • 04支持自定义 JSON 样式表。
  • 05可设置输出换行宽度,并通过 less 等分页器显示。
  • 06可将常用选项保存到 YAML 配置文件中。

适用场景

  • 不离开终端即可阅读项目文档或 README。
  • 在 SSH 连接的远程服务器上预览 Markdown 文件。
  • 在 shell 脚本中将生成的 Markdown 输出为易读的格式化内容。

快速上手

  1. 1

    使用 Homebrew 安装(macOS 或 Linux)

    brew install glow
  2. 2

    在终端中阅读 Markdown 文件

    glow README.md
  3. 3

    启动本地 Markdown 文件的交互式浏览器

    glow

标签

常见问题

glow 是什么?
在终端中渲染和浏览 Markdown 文件的命令行工具,支持样式化显示。 Glow 是一款终端 Markdown 阅读器。不带参数运行时会打开浏览界面,列出当前目录及子目录(若位于 Git 仓库中则搜索整个仓库)的本地 Markdown 文件,并以类似 less 的快捷键进行阅读。
glow 可以免费使用吗?用的什么许可证?
glow 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
glow 还在维护吗?
活跃维护中。glow 最近一次提交是在 2026年10月5日。
glow 适合用来做什么?
不离开终端即可阅读项目文档或 README。 在 SSH 连接的远程服务器上预览 Markdown 文件。 在 shell 脚本中将生成的 Markdown 输出为易读的格式化内容。
glow 怎么安装和运行?
使用 Homebrew 安装(macOS 或 Linux): brew install glow 在终端中阅读 Markdown 文件: glow README.md 启动本地 Markdown 文件的交互式浏览器: glow
在哪里获取 glow?
源代码和安装说明在 GitHub 上:https://github.com/charmbracelet/glow

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目