我正在为我的github项目写一个自述文件。md格式。有什么方法可以测试我的自述。Md文件在提交到github之前会是什么样子?


当前回答

使用Jupyter Lab。

要安装Jupyter Lab,请在您的环境中输入以下命令:

pip install jupyterlab

安装后,浏览到您的markdown文件的位置,右键单击文件,选择“打开”,然后单击“markdown预览”。

其他回答

自2012年(当这个问题被创建时)GitHub本身可以:

在常规存储库中创建并显示Markdown文档的预览(自2011年8月以来一直如此) 或者,如果你不想直接影响你的存储库,对gist做同样的事情(自2020年12月起) 即使没有提交要点,自2021年11月起,您也可以在您正在编辑(但尚未提交)的要点中预览Markdown文档

一旦要旨的预览看起来不错,你就可以将要旨的标记复制到你当地的README中。Md,添加,提交和推送。

Visual Studio Code具有编辑和预览md文件更改的选项。因为VS Code是独立于平台的,所以这适用于Windows、Mac和Linux。

要在视图之间切换,请在编辑器中按Ctrl+Shift+V。您可以与正在编辑的文件并排查看预览(Ctrl+K V),并在编辑时查看实时反映的更改。

也……

问:VS Code是否支持GitHub调味Markdown? 答:不,VS Code使用Markdown -it库来实现CommonMark Markdown规范。GitHub正在向CommonMark规范迈进。

预览按钮如下:

详情请点击这里

VS代码

Mac: Command + Shift + V

Windows操作系统:Ctrl + Shift + V

详细说明

在VS Code中打开.md文件。选定文件后,使用上面的键盘快捷键。

我只是创建了一个“功能”分支,并将其推送到github,在那里我做出了改变,这变得可见,他们将如何在github中看起来。

然后,当我满意的时候,我就把base调回main,或者对main执行一个pull请求,不管你碰巧在使用哪个进程。

使用git时,很少需要在本地进行测试,除非您的存储库位于公司防火墙后面,或者需要离线工作。

在这种情况下,Atom和VScode都有不错的Markdown渲染器,不足以在github上显示你的更改,但足以看到你的更改是否朝着正确的方向发展。

我通常只是直接在GitHub网站上编辑它,然后点击编辑窗口上方的“预览”。

也许这是自这篇文章以来添加的一个新功能。