Glow

官方

github.com开发者工具27.8kglow4 周前更新

代码仓库访问官网

关于 Glow

Glow 是一个 Markdown 阅读器，在终端中以优雅的格式呈现 Markdown 文件。支持语法高亮、分页和目录浏览。

主要功能

01在终端中呈现带有语法高亮的 Markdown
02浏览本地和远程 Markdown 文件
03以交互式分页模式显示长文档

适用场景

01查看和浏览项目 README 和文档
02编码 Agent 解析和显示 Markdown 格式的文档

安装

选择你的系统或包管理器，复制命令到终端运行。

brew install glow

安装完成后运行glow --version确认安装成功。

命令示例

常用命令按使用顺序排列。

glow README.md

glow -p README.md

详细介绍

Glow

在命令行中渲染 Markdown，尽显风采！

Glow 界面演示

这是什么？

Glow 是一款基于终端的 Markdown 阅读器，从一开始便旨在展现命令行的美感与强大功能。

你可以用它发现 Markdown 文件，并直接在命令行中阅读文档。Glow 会在子目录或本地 Git 仓库中查找 Markdown 文件。

安装

包管理器

# macOS or Linux
brew install glow

# macOS (with MacPorts)
sudo port install glow

# Arch Linux (btw)
pacman -S glow

# Void Linux
xbps-install -S glow

# Nix shell
nix-shell -p glow --command glow

# FreeBSD
pkg install glow

# Solus
eopkg install glow

# Windows (with Chocolatey, Scoop, or Winget)
choco install glow
scoop install glow
winget install charmbracelet.glow

# Android (with termux)
pkg install glow

# Ubuntu (Snapcraft)
sudo snap install glow

# Debian/Ubuntu
sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg
echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | sudo tee /etc/apt/sources.list.d/charm.list
sudo apt update && sudo apt install glow

# Fedora/RHEL
echo '[charm]
name=Charm
baseurl=https://repo.charm.sh/yum/
enabled=1
gpgcheck=1
gpgkey=https://repo.charm.sh/yum/gpg.key' | sudo tee /etc/yum.repos.d/charm.repo
sudo yum install glow

也可以从发布页面下载二进制文件。提供适用于 macOS、Linux、Windows、 FreeBSD 和 OpenBSD 的二进制文件，以及 Debian、RPM 和 Alpine 软件包。macOS、Linux、FreeBSD 和 OpenBSD 也提供 ARM 版本。

Go

也可以直接用 go 安装：

go install charm.land/glow/v3@latest

构建（需要 Go 1.21+）

git clone https://github.com/charmbracelet/glow.git
cd glow
go build

TUI

不带参数运行 glow，即可启动文本用户界面并浏览本地文件。Glow 会查找当前目录及其下级目录中的 Markdown 文件；如果你位于 Git 仓库中，Glow 则会搜索该仓库。

你可以使用 Glow 的高性能分页器阅读 Markdown 文件。它的大部分按键操作与 less 相同，但你可以按 ? 查看快捷键列表。

CLI

除了 TUI，Glow 还提供用于处理 Markdown 的 CLI。要格式化文档，请将 Markdown 源文件作为主要参数：

# Read from file
glow README.md

# Read from stdin
echo "[Glow](https://github.com/charmbracelet/glow)" | glow -

# Fetch README from GitHub / GitLab
glow github.com/charmbracelet/glow

# Fetch markdown from HTTP
glow https://host.tld/file.md

自动换行

-w 标志可用于设置输出换行的最大宽度：

glow -w 60

分页

使用 -p 标志，可通过你偏好的分页器显示 CLI 输出。如果未显式设置 $PAGER，默认使用支持 ANSI 的 less -r。

样式

你可以使用 -s 标志选择样式。如果未提供该标志，glow 会尝试检测终端当前的背景颜色，并自动为你选择 dark 或 light 样式。

glow -s [dark|light]

你也可以提供自定义 JSON 样式表：

glow -s mystyle.json

如需了解更多用法详情，请参阅：

glow --help

前往 Glamour 样式部分查看更多样式。也可以创建自己的样式！

配置文件

如果你发现自己总是向 glow 提供相同的标志，不妨创建一个配置文件。运行 glow config，即可在你常用的 $EDITOR 中打开配置文件。你也可以在平台的默认配置路径下手动创建名为 glow.yml 的文件。如果不确定该路径在哪里，请参阅 glow --help。

以下是一个配置示例：

# style name or JSON path (default "auto")
style: "light"
# mouse wheel support (TUI-mode only)
mouse: true
# use pager to display markdown
pager: true
# at which column should we word wrap?
width: 80
# show all files, including hidden and ignored.
all: false
# show line numbers (TUI-mode only)
showLineNumbers: false
# preserve newlines in the output
preserveNewLines: false

参与贡献

请参阅贡献指南。

反馈

我们很乐意听到你对这个项目的想法。欢迎随时给我们留言！

许可证

MIT

Charm 的一部分。

Charm 热爱开源 • Charm loves open source

支持 Markdown

登录后评论