gfm-preview

Usage

# install it 
$ npm install --global gfm-preview
 
# preview your markdown 
$ preview file.md
 
# preview with firefox 
$ preview file.md --browser firefox
 
# preview with chrome on macOS 
$ preview file.md --browser 'google chrome'
 
# preview custom host and port number 
$ preview file.md --host yourhost --port 3333
 
# preview with GitHub Enterprise API 
$ preview file.md --github-api-url https://your-ghe-host:port/api/v3

Feature

• Render your markdown with GitHub API
• Launch a local preview server (http://localhost:4649)
• Hot reload previews when detecting changes
• Close the server when the preview is closed
• Support GitHub Enterprise

How to change default browser

The browser name is platform dependent. For example, Chrome is google chrome on macOS, google-chrome on Linux and chrome on Windows.

# with chrome on macOS 
$ preview file.md --browser 'google chrome'
 
# with a custom executable 
$ preview file.md --browser 'C:\\Program Files\\Mozilla Firefox\\firefox.exe'

If you use GitHub Enterprise (GHE)

Add an alias to your ~./bashrc:

alias preview='preview --github-api-url https://your-ghe-host:port/api/v3'

Then use it:

$ preview file.md