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


当前回答

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

安装Markdown编辑器扩展

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

其他回答

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

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

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

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

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

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

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

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

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

如果你正在使用Pycharm(或其他Jetbrains IDE,如Intellij, RubyMine, PHPStorm等),在你的IDE中有多个免费的Markdown支持插件,允许在编辑时实时预览。Markdown Navigator插件相当不错。如果您在IDE中打开一个.md文件,最新版本将提供安装支持插件并显示列表。