如何在提交推送至GitHub前本地预览README.md变更
本地Commit/Push前预览README.md渲染效果的方法
不用把内容推到远程仓库再反复修改调整,本地就能直接看到和GitHub线上一致的渲染效果,常用方法有这几种:
- 代码编辑器自带预览:日常写代码用的VS Code、WebStorm等主流编辑器都原生支持Markdown实时预览。以VS Code为例,打开项目里的README.md文件后,按快捷键
Ctrl+K V(Windows/Linux)/Cmd+K V(Mac)就能调出分屏预览窗口,编辑内容时预览效果实时同步,常用的标题、列表、代码块、引用、本地图片等基础语法渲染结果和GitHub线上几乎无差。 - 本地命令行工具渲染:如果平时习惯用终端操作,可以安装轻量的本地渲染工具grip,装完直接在README所在的项目根目录执行
grip命令,工具会在本地启动一个临时Web服务,按照提示打开本地对应端口的地址,浏览器里看到的效果和GitHub线上完全匹配,连GitHub专属的emoji、任务列表、样式细节都能对齐,预览完成后在终端按Ctrl+C关闭服务即可。 - Git图形客户端内置预览:如果用GitHub Desktop、SourceTree这类GUI工具管理Git操作,在提交确认界面选中待提交的README.md文件时,工具自带的预览区除了显示文本改动差异,还支持切换到渲染视图,直接就能看到修改后的最终展示效果,刚好在点commit按钮前做最后核对。
小提示:如果README里用到了GitHub特有的扩展语法(比如自动关联issue、项目徽章、任务列表这类),尽量选对齐GitHub渲染规则的预览方式,避免本地显示正常、推到远程后格式错乱。
内容的提问来源于stack exchange,提问作者Mark Harrison
相关产品推荐
相关产品推荐

