GitHub - thiagokokada/gh-gfm-preview:一个独立的/GitHub CLI 扩展,用于预览 GitHub 风味 Markdown,甚至离线。

这是一个用 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 访问的功能。
  • 安装

    • GitHub 扩展:需安装gh,然后执行gh extension install thiagokokada/gh-gfm-preview进行安装,或gh extension upgrade markdown-preview进行升级。
    • 独立版本:需安装Go,执行go install github.com/thiagokokada/gh-gfm-preview@latest
    • Nix:假设启用了Flakes,执行nix run github:thiagokokada/gh-gfm-preview
  • 用法:使用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 等。
阅读 13
0 条评论