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


当前回答

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

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

其他回答

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

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

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

我使用markdownlivepreview: https://markdownlivepreview.com/

这是非常容易,简单和快速。

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

安装Markdown编辑器扩展

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

这个已经被证明是可靠的:http://tmpvar.com/markdown.html

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

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

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

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