/mdpreview

Preview markdown files

Primary LanguageGoApache License 2.0Apache-2.0

mdpreview

Preview markdown files.

Markdown files are rendered using Github API. GitHub Markdown style are provided by github-markdown-css.

Installation

You need go installed and GOBIN in your PATH. Once that is done, run the command:

$ go get -u github.com/thiamsantos/mdpreview

Usage

Usage
  $ mdpreview [options]

Options
  -i string
        Markdown file to render (default "README.md")

Examples
  $ mdpreview
  $ mdpreview -f some/file.md