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


当前回答

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

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

其他回答

这是一个相当老的问题,但由于我是在网上搜索时偶然发现的,也许我的答案对其他人有用。 我刚刚发现了一个非常有用的CLI工具来渲染GitHub风味markdown: grip。它使用GitHub的API,因此渲染得很好。

坦率地说,《grip》的开发者对这些类似的问题有更详细的回答:

是否有一个命令行实用程序渲染github风味markdown? 编辑GitHub的Readme.md的最好方法是什么?

我知道这个问题很老了,也许有人在谷歌上搜索了如何到达这里。 这就是我对这个问题的看法。

你可以使用原子文本编辑器和切换markdown预览甚至在github风格。

新闻

ctrl+shift+m

窗口将弹出或使用Packages—>Markdown预览。

希望这能帮助到一些人。

Atom工作得很好-只需打开Markdown文件,并按Ctrl+Shift+M切换Markdown预览面板旁边。它还处理HTML和图像。

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

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

使用Jupyter Lab。

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

pip install jupyterlab

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