这是一个用 Go 编写的用于预览 GitHub Flavored Markdown(GFM)的程序gh-gfm-preview
:
- 功能:使用yuin/goldmark及一些扩展和前端技巧来渲染 HTML,使其外观和功能类似于 GitHub 对 Markdown 的渲染。可作为GitHub CLI的扩展,也可离线使用。
- 截图:展示了在浏览器中打开的预览效果以及实时重载功能的视频。
- 亮点:支持离线工作、快速、无依赖、零配置、实时重载、自动打开浏览器、自动查找端口、优雅降级等。
- 支持的 GFM 功能:涵盖大部分(所有?)GitHub Flavored Markdown 规范,包括表情符号、警报、代码块语法高亮、章节链接、原生 HTML、MathJax、Mermaid 图、GeoJSON/TopoJSON 图、STL 3D 图以及提及人员、引用问题和拉取请求等依赖 GitHub 访问的功能。
安装:
- 用法:使用
gh gfm-preview README.md
或在目录中自动检测README
文件来启动本地 Web 服务器,可通过--dark-mode
、--disable-auto-open
等选项进行配置,默认端口为 3333,可通过--host
和--port
更改。 - 其他用法:可用于在
neovim
等编辑器中预览 Markdown 效果,通过在$HOME/.config/nvim/init.lua
中添加代码创建快捷键。 - 开发:可通过
go generate./...
重新生成资产,go build
进行构建。 - 相关项目:包括 GitHub CLI、Grip、github-markdown-css、gh-markdown-preview 等。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。