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


当前回答

Visual Studio Code具有编辑和预览md文件更改的选项。因为VS Code是独立于平台的,所以这适用于Windows、Mac和Linux。

要在视图之间切换,请在编辑器中按Ctrl+Shift+V。您可以与正在编辑的文件并排查看预览(Ctrl+K V),并在编辑时查看实时反映的更改。

也……

问:VS Code是否支持GitHub调味Markdown? 答:不,VS Code使用Markdown -it库来实现CommonMark Markdown规范。GitHub正在向CommonMark规范迈进。

预览按钮如下:

详情请点击这里

其他回答

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

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

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

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

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

新闻

ctrl+shift+m

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

希望这能帮助到一些人。

崇高文本 2/3

安装包:Markdown预览

选项:

在浏览器中预览。 导出到html。 复制到剪贴板。

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

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

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

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