gh markdown-preview

GitHub CLI extension to preview your markdown similar to the style of GitHub :octocat:

gh markdown-preview is a GitHub CLI extension to preview your markdown such as README.md. The gh markdown-preview commnad start a local web server to serve your markdown document file with a GitHub stlye. gh markdown-preview show the HTML got from GitHub official markdown API with the CSS extracted from GitHub web site. The styles are almost the same!

Screenshot of gh markdown-preview

Installation

$ gh extension install yusukebe/gh-markdown-preview

Usage

The usage:

$ gh markdown-preview README.md

Then access the local web server such as http://localhost:3333 with Chrome, Firefox, or Safari.

Available options:

-p, --port            TCP port number of this server (default: 3333)

gh markdown-preview command

Related projects

Author

Yusuke Wada http://github.com/yusukebe

License

Distributed under the MIT License.

GitHub

View Github