Repolode
提交项目
thiagokokada

thiagokokada/gh-gfm-preview

一个 Go 编写的命令行工具与 GitHub CLI 扩展，可在本地启动网页服务预览 GFM Markdown，支持离线使用。

可替代:GitHub Markdown preview

在 GitHub 查看
Star
133
Fork
4
未关闭 Issue
0
最近提交
3个月前

这是什么？

gh-gfm-preview 会启动一个本地网页服务，在浏览器中渲染 Markdown 文件，外观力求接近 GitHub 的显示效果。渲染基于 yuin/goldmark 及其扩展在本地完成，因此大多数功能无需联网即可使用。

它既可以作为独立二进制文件运行，也可以作为 GitHub CLI 扩展使用（`gh gfm-preview`）。输入可以是文件路径、标准输入，或自动识别当前目录下的 README；文件变化时支持实时重载。目录浏览模式则可以浏览并预览多个 Markdown 或文本文件。

该项目是 gh-markdown-preview 的硬分支，后者依赖 GitHub Markdown API，需要联网。依赖 GitHub 访问的功能，如提及用户、引用 issue，则不在支持范围内。

核心功能

  • 01基于本地 goldmark 扩展渲染 GFM，可离线工作
  • 02支持 Mermaid 图表、MathJax 数学公式、提示框与语法高亮代码块
  • 03文件变化时浏览器自动实时刷新
  • 04支持文件路径、标准输入或自动识别 README 作为输入
  • 05目录浏览模式，可预览多个文件
  • 06可作为独立二进制文件或 GitHub CLI 扩展运行

适用场景

  • 在推送到 GitHub 之前预览 README 或文档草稿
  • 在 Neovim 等编辑器中通过快捷键预览 Markdown
  • 在网络不稳定或离线环境中编写 Markdown

快速上手

  1. 1

    将其安装为 GitHub CLI 扩展

    gh extension install thiagokokada/gh-gfm-preview
  2. 2

    在浏览器中预览 Markdown 文件

    gh gfm-preview README.md

使用前须知

  • GeoJSON/TopoJSON 图表和地图功能需要联网，且不支持 STL 3D 图表。
  • 不支持提及用户、引用 issue 和 pull request 等依赖 GitHub 访问的功能。
  • 渲染效果是对 GitHub 的模拟，与 GitHub 的输出接近但并不完全相同。

标签

#markdown#cli#gfm#golang#offline#preview#gh-extension#go

常见问题

gh-gfm-preview 是什么？
一个 Go 编写的命令行工具与 GitHub CLI 扩展，可在本地启动网页服务预览 GFM Markdown，支持离线使用。 gh-gfm-preview 会启动一个本地网页服务，在浏览器中渲染 Markdown 文件，外观力求接近 GitHub 的显示效果。渲染基于 yuin/goldmark 及其扩展在本地完成，因此大多数功能无需联网即可使用。
gh-gfm-preview 可以免费使用吗？用的什么许可证？
gh-gfm-preview 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
gh-gfm-preview 还在维护吗？
半年内有更新。gh-gfm-preview 最近一次提交是在 2026年7月24日。
gh-gfm-preview 适合用来做什么？
在推送到 GitHub 之前预览 README 或文档草稿 在 Neovim 等编辑器中通过快捷键预览 Markdown 在网络不稳定或离线环境中编写 Markdown
gh-gfm-preview 怎么安装和运行？
将其安装为 GitHub CLI 扩展: gh extension install thiagokokada/gh-gfm-preview 在浏览器中预览 Markdown 文件: gh gfm-preview README.md
在哪里获取 gh-gfm-preview？
源代码和安装说明在 GitHub 上：https://github.com/thiagokokada/gh-gfm-preview

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

相关项目