gh markdown-preview：GitHub风格的Markdown预览神器

gh markdown-preview：GitHub风格的Markdown预览神器

gh-markdown-previewGitHub CLI extension to preview Markdown looks like GitHub.项目地址:https://gitcode.com/gh_mirrors/gh/gh-markdown-preview

项目介绍

gh markdown-preview 是一款专为开发者设计的 GitHub CLI 扩展工具，旨在帮助用户在本地预览 Markdown 文件，使其外观与 GitHub 上的渲染效果几乎一致。无论是 README.md 还是其他 Markdown 文件，gh markdown-preview 都能让你在提交到 GitHub 之前，提前看到最终的渲染效果。

项目技术分析

gh markdown-preview 的核心技术在于利用 GitHub 官方的 Markdown API 来渲染 HTML，并通过提取 GitHub 网站的 CSS 样式，确保本地预览与线上效果高度一致。项目采用了轻量级的设计，无需额外依赖，只需安装 gh 命令即可使用。此外，gh markdown-preview 还支持实时重载、自动打开浏览器、自动寻找可用端口等功能，极大地提升了开发者的使用体验。

项目及技术应用场景

gh markdown-preview 适用于以下场景：

• 文档编写与预览：开发者在编写项目文档时，可以实时预览 Markdown 文件的渲染效果，确保文档在 GitHub 上的展示效果符合预期。
• 博客与文章撰写：博客作者或技术文章撰写者可以在本地预览 Markdown 文件，确保文章排版美观，避免线上渲染出现意外问题。
• 团队协作：团队成员在协作编写文档时，可以利用 gh markdown-preview 快速预览文档效果，减少沟通成本。

项目特点

• 无依赖：仅需 gh 命令，无需安装其他依赖包。
• 零配置：无需设置 GitHub 访问令牌，开箱即用。
• 高度一致性：本地预览效果与 GitHub 线上渲染几乎一致。
• 实时重载：编辑 Markdown 文件时，浏览器会自动刷新，无需手动刷新页面。
• 自动打开浏览器：启动预览后，浏览器会自动打开预览页面。
• 自动寻找端口：如果默认端口被占用，工具会自动寻找可用端口。

安装与使用

安装

gh extension install yusukebe/gh-markdown-preview

升级

gh extension upgrade markdown-preview

使用

gh markdown-preview README.md

或者自动检测当前目录下的 README 文件：

gh markdown-preview

启动后，访问 http://localhost:3333 即可在浏览器中查看预览效果。

可用选项

    --dark-mode           强制使用暗黑模式
    --disable-auto-open   禁用自动打开浏览器
    --disable-reload      禁用实时重载
-h, --help                显示帮助信息
    --host string         服务器绑定的主机名（默认 "localhost"）
    --light-mode          强制使用亮色模式
-p, --port int            服务器端口号（默认 3333）
    --verbose             显示详细输出
    --version             显示版本信息

相关项目

• GitHub CLI: https://cli.github.com
• Grip: https://github.com/joeyespo/grip
• github-markdown-css: https://github.com/sindresorhus/github-markdown-css

作者

Yusuke Wada: http://github.com/yusukebe

许可证

本项目基于 MIT 许可证发布。

gh-markdown-previewGitHub CLI extension to preview Markdown looks like GitHub.项目地址:https://gitcode.com/gh_mirrors/gh/gh-markdown-preview