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


当前回答

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

其他回答

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

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

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

VS代码

Mac: Command + Shift + V

Windows操作系统:Ctrl + Shift + V

详细说明

在VS Code中打开.md文件。选定文件后,使用上面的键盘快捷键。

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

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

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

对于Visual Studio Code,我使用

Markdown预览增强扩展。