View markdown files offline

 

Is there a way to display .md files offline so we know what it will look like once it's uploaded in Github? I'm referring to showing the README.md file as it would come out in Github, and not as for editing purposes.

Needs to work on Mac and Windows since I use both.

There are a few Chrome plug-ins that work well. I've been using Markdown Preview Plus.

After install, enable "Allow access to file URLs" in Extensions (menu > More tools > Extensions or enter URL chrome://extensions/ instead).

在这里输入图像描述

Then drag-n-drop a Markdown file onto Chrome and use your favorite editor to edit.

I wrote Grip a while ago to do exactly this. It renders exactly like it does on GitHub and provides several additional options too:

  • In addition to READMEs, Grip can renders GitHub comments and issues
  • Click through local links to render other .md files
  • An API to use in your own projects
  • Export to an HTML file

    • Install with pip: 

    pip install grip

    Then go to the directory that contains your README file and run: 

    grip

    Pass -h for additional help and options.

    Here's a screenshot of Grip rendering Grip's README:

    Grip渲染手柄的屏幕截图

    Hope this helps. Check it out here.

    Atom by Github. Gives you a side by side preview.

    在这里输入图像描述

    https://stackoverflow.com/a/26956920/375022

    链接地址: http://www.djcxy.com/p/20216.html

    上一篇: 链接到GitHub上的一个Markdown文件

    下一篇: 离线查看markdown文件