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


当前回答

我发现markdownlivepreview.com非常接近于香草GitLab markdown。 其他查看器对命令的解释与GitLab略有不同。

其他回答

Markdown预览,在之前的评论中提到的Sublime Text插件不再与ST2兼容,但只支持Sublime Text 3(自2018年春季以来)。

它的优点是:它支持GFM, GitHub调味Markdown,它可以做的比常规Markdown多一点。如果你想知道你的.mds在GH上是什么样子的,这是有关联的。(包括这一点信息,因为OP自己没有添加GFM标签,其他寻找解决方案的人可能也不知道它。)

如果你在线,你可以将它与GitHub API一起使用,不过你应该为此获得一个个人访问令牌,因为没有身份验证的API调用是有限的。在插件的文档中有更多关于解析GFM的信息。

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

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

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

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

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

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

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

安装Markdown编辑器扩展

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