查看离线的Markdown文件

Question

有没有一种方法可以离线显示.md文件，以便我们知道上传到Github后它的外观？ 我指的是展示 README.md 文件，就像在Github中呈现的样子，而不是为编辑目的。

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

- enchance

Answer 1

有几个适用的Chrome插件。我一直在使用Markdown预览加强版。

安装后，在扩展中启用“允许访问文件URL”（菜单 > 更多工具 > 扩展程序或输入URL chrome://extensions/ ）。

然后将Markdown文件拖放到Chrome浏览器并使用您喜欢的编辑器进行编辑。

- Jim Bergman

Answer 2

我之前写了一个叫做Grip的工具，它可以实现与GitHub上完全一样的渲染效果，并提供了其他几个选项:

• 除README外，Grip还可以渲染GitHub评论和问题
• 点击局部链接以便渲染其他.md文件
• 可在自己的项目中使用的API
• 导出为HTML文件

使用pip安装:

pip install grip

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

grip

输入-h获取更多帮助和选项。

这是Grip渲染Grip自述文件的屏幕截图：

在这里查看。

- Joe

---

@luchosrock，你能发布一份Markdown代码片段，让它无法正确渲染吗？如果存在任何不匹配的地方，我将提交一个bug并进行修复。 - Joe

我认为你可能将两者混淆了。根据gfms的文档，“GFMS的当前实现不会着色源代码块”，而Grip则会。 Grip使用GitHub自己的Markdown API和开箱即用的样式，而不是定制解决方案，这也是使Grip如此准确的原因。另外，gfms是基于Node，不是Python。 - Joe

与其他解决方案不同，它在Linux上完美运行！谢谢！ - akhmed

请注意，Github Wiki中的链接不起作用。例如，您链接到[foo]（foo），它尝试打开页面foo，但实际上应该打开foo.md。 - Hugh Perkins

这是一个有用的工具，但它似乎使用GitHub的API在浏览器中呈现页面。当我刷新页面超过30次时，会出现“GitHub速率限制已达到”的错误。看起来Grip不支持离线查看。 - Neha Karanjkar

Answer 3

Atom 是由 Github 推出的一款编辑器，可以提供并排预览功能。

- Maxim

---

如果你需要编辑许多 .md 文件，这个功能非常不错。而且，无需切换到另一个应用程序即可进行即时预览，这总是一个优点。 - dval

甚至有一个自动滚动的包：https://github.com/mark-hahn/markdown-scroll-sync。目前，您需要修补https://github.com/mark-hahn/markdown-scroll-sync/pull/66/files才能使其正常工作而没有警告。 - Dror

这也是一个很好的建议。并排窗格的即时预览是一个额外的奖励！无需不断保存和切换标签页。 - AnimNations

在Atom中，点击“Packages -> Markdown Preview -> Toggle Preview”以查看渲染后的文档。 - BurnsBA

现在微软已经停止支持Atom，有人可以推荐一款仍然得到GitHub团队认可的替代品吗？ - WeakPointer

现在微软已经停止维护 Atom。有人可以推荐一款仍然得到 GitHub 团队认可的替代产品吗？ - WeakPointer

Answer 4

Visual Studio Code - 微软推出的新编辑器，也提供了非常好的支持markdown编辑。
你可以从这里下载。
该编辑器提供了良好的支持在markdown代码和预览模式之间进行切换。
它也为所有markdown语法提供了相当好的intellisense支持。
该编辑器是免费使用的，并且还是跨平台的（适用于Linux、Windows和Mac）。
更多详情，您可以查看他们的网站

- sundeep

---

酷，这是我已经安装的解决方案！我还有两个小问题需要解决：要打开预览窗格，请右键单击顶部的文件选项卡，然后选择“打开预览 (Ctrl+Shift+V)”；要调用@sundeep提到的智能感知功能，在编辑器窗口中按Ctrl+Space。 - arichards

使用 Ctrl+K V 预览。 - aderchox

如果有人在使用 macOS 时遇到困难，可以尝试组合键 Cmd + Shift + v。 - Zoso

Answer 5

晚到派对了，但看看MarkdownPad。

- David Brabant

---

如果你想使用 GitHub 风格的 Markdown，你需要购买MarkdownPad Pro，价格约为15美元。我个人愿意支付5美元，但绝对不会支付15美元。所以如果有人可以推荐其他的工具，请提供建议。 - floriank

刚刚支付了15美元购买专业版，我认为它非常值得，但如果能在Mono上运行就更好了，这样我就可以在Linux/OSX上使用，因为现在我的开发工作更多地倾向于这些操作系统。 - Tracker1

MarkdownPad 似乎在一段时间内停滞不前，所以我（披露警告：是的，我制作并销售这个）制作了 MarkUpDown，价格为 $15，还算不错。应该支持 GitHub Markdown，如果不支持，请告诉我具体问题，我会尽快解决。 - ruffin

Answer 6

查看Python-Markdown-Editor

它基于：

• Python-Markdown
• Pygments（代码块语法高亮）
• CodeMirror（JavaScript 代码编辑器）
• Bottle

使用 pip 安装：

$ pip install markdown-editor 

它具有实时预览、代码高亮、围栏式代码块和 GitHub 风格。

它可以通过命令行使用：

$ markdown_edit 

$ markdown_edit README.md

$ markdown_edit -f readme.html README.md

我创建了这个工具来构建一个发送代码审查的工具，它很容易扩展，通过将其作为模块导入，您可以添加自定义操作。

- Nicolas Cornette

---

你好，这似乎是一个很棒的应用程序，但我无法同时打开两个 .md 文件，因为大多数时候我只想让它成为一个查看器而不是编辑器。您是否可以扩展此功能，添加类似于 http://localhost:8000/<path/to/file.md> 的语法，以便能够查看多个 .md 文件？ - arcticfox

您可以使用“-p <端口号>”选项编辑多个文件。 - Nicolas Cornette

对我来说会出现Traceback错误。 - aderchox

可以工作，但需要检查最新问题，关于需要的Python-Markdown版本。例如，这份报告“使用pip安装时，安装过程很顺利，但是当从命令行启动编辑器时，会抛出以下错误：ModuleNotFoundError: No module named 'pymdownx.extrarawhtml'卸载pymdown-extensions并重新安装以前的版本，例如pymdown-extensions==7.0，解决了我的问题。这是因为安装要求是pymdown-extensions>=2.0，但可以通过指定确切的版本来快速修复问题。” - Goblinhack

Answer 7

我刚刚安装了https://github.com/ypocat/gfms，它非常擅长渲染Github风格的markdown。它会检测您的markdown文件是否有更改，所以您只需要将您的浏览器和编辑器并排放置即可。它是基于Node.js开发的，因此可以在任何平台上良好运行。

如果你已经安装了Node.js，那么安装过程很简单：

1. sudo npm install -g gfms
2. gfms --port 9999（在你的项目目录中）
3. http://localhost:9999/（用任何浏览器打开）

- pduey

---

不幸的是，“gfms”不能像GFM一样呈现换行符——当段落中有一个单独的换行符时，它不会像GFM那样插入一个<br>。但对于“纯”Markdown渲染，它是可以的。 - Ed Ruder

有一个更新的版本的 gfms (github.com/pawel-wiejacha/gfms)，它使用更好的 GFM Markdown 后端 (Marked) 并正确插入换行符。它还改进了目录列表和 PDF 导出功能。 - Pawel Wiejacha

我尝试了这个方法因为听起来很有希望。我需要安装node.js（没什么意外），但还要安装python。当它要求完整的C++开发工具链时我放弃了。所以，根据你的平台，这可能很容易，但如果你在Windows上，不要尝试这个建议。 - Chase

几乎没有在Windows上能运行的NodeJS程序。当一份“安装软件”的指南以“npm install”开始时，我已经吃过亏，只好放弃。NodeJS并不像开发者所说的跨平台。 Golang和Python也同样糟糕，但不如Node那么糟糕。唯一我知道真正跨平台且几乎不需要任何额外安装的脚本语言是PHP。PHP CLI是一颗隐藏的宝石 - 它比其他任何命令行脚本语言都要好。 - CubicleSoft

Answer 8

我找到了一种在PHP中查看它的方法。在进行了更多的调查后，我找到了两种离线和在线查看.md文件的解决方案：

• 离线： https://github.com/WolfieZero/Markdown-Viewer-PHP
• 在线： http://daringfireball.net/projects/markdown/dingus

我建议使用离线版本，这样你甚至可以在沙发上做生意时进行编辑。

- enchance

---

还有很多桌面应用程序可以查看.md文件。 - Matt Ball

我不知道那是什么？ - enchance

谷歌搜索“markdown编辑器”会很快显示出http://markdownpad.com/。 - Matt Ball

@enchance，为什么选择PHP？用JavaScript版本会更好。 - Pacerier

Answer 9

有些人不使用Google Chrome。有一个名为Markdown Viewer的Firefox插件可以离线阅读Markdown文件。

- air-dex

Answer 10

Pandoc 是一款优秀的文本转换工具，它解决了 Markdown 离线可视化的难题。只需输入:

pandoc -f markdown -t html README.md > README.html

- tonicebrian