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

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

当前回答

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

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

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

其他回答

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

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

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

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

一种方法是使用Pandoc(非常有用)。

复制你的降价投诉文本到剪贴板运行: Xsel -b | pandoc -s -f markdown -t HTML | xclip -select clipboard -t text/ HTML | Xsel -b 粘贴生成的格式化文本(例如在电子邮件或LibreOffice上)。

你说你用的是Linux。你只需要安装pandoc, xsel和xclip包。

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

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

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

只要在网上搜索一下，就会得到很多这样的答案: https://stackedit.io/

推荐文章