是否有一种方法可以离线显示。md文件,这样我们就可以知道它上传到Github后会是什么样子?我指的是显示README。md文件,因为它将出现在Github,而不是作为编辑的目的。

需要在Mac和Windows上工作,因为我都用。


当前回答

不久前我写了Grip,就是为了做到这一点。它渲染完全像它在GitHub上,并提供了几个额外的选项:

除了readme, Grip还可以渲染GitHub评论和问题 单击本地链接以呈现其他.md文件 在您自己的项目中使用的API 导出到HTML文件

使用pip安装:

pip install grip

然后进入包含README文件的目录并运行:

grip

传递-h以获得额外的帮助和选项。

这是Grip渲染的README截图:

点击这里查看。

其他回答

考虑捷联式。

Strapdown是基于javascript的解决方案,它在浏览器中呈现降价内容,这使得它非常适合脱机查看。 从他们自己的描述来看:

Strapdown.js使得创建优雅Markdown文档变得非常简单。不需要服务器端编译。

所以重命名你的。md markdown文件为。html,并围绕它:

<xmp theme="united" style="display:none;">
# Markdown content here
…
</xmp>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>

并且在任何浏览器中打开都会显示呈现的HTML。额外的好处:你可以很容易地改变主题。

在MacOSX上运行良好的最简单的资源之一是InkMark上的Markdown Quick Look插件。在OS X 10.9+上安装后,你只需在Finder中选择一个降价文件,然后点击空格键。我不确定结果是否与Github 100%相关,但他们是相当不错的,使一个微小的不显眼的离线查看者唯一的解决方案。Mashable也写了一篇关于78种不同工具的文章,如果你想要其他选择。

我喜欢Downmarker中的垂直分割器,你可以在写作时看到变化!

这个php查看器提供响应式支持和许多自定义选项。

文件:http://www.binpress.com/app/codespire response - markdownviewer/2112

非凡,当然是一个伟大的工具。

注意:不适用于Mac

特点:

实时预览 这是免费的。 非常轻量级的 导出为HTML, PDF

下载:https://remarkableapp.github.io/。

编辑2022

我现在使用并喜欢Mark Text。(https://marktext.app)