我如何测试我的自述。Md文件在提交到github之前会是什么样子?

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

当前回答

使用Jupyter Lab。

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

pip install jupyterlab

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

其他回答

对于Github或Bitbucket主题，可以使用在线编辑器mattstow, url: http://writeme.mattstow.com

针对Visual Studio用户(不是VS CODE)。

安装Markdown编辑器扩展

这样，当你打开一个README。医生，你可以在右边看到现场预览。

MarkdownViewerPlusPlus 是“[…]] notepad++插件查看Markdown文件渲染在飞行特性

可停靠的面板(切换)，带有当前选定文件/选项卡的渲染HTML CommonMark兼容(0.28) 同步滚动自定义CSS集成 HTML和PDF导出 notepad++ Unicode插件 […]”

有很多方法:如果你用的是Mac，使用Mou。

如果您想在浏览器中测试，您可以尝试StackEdit，正如@Aaron或Dillinger指出的那样，因为Notepag现在似乎已经关闭了。就我个人而言，我使用Dillinger，因为它可以将我所有的文档保存在浏览器的本地数据库中。

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

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

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

推荐文章