Go to file
2022-05-08 17:53:43 -07:00
css Cleanup 2022-05-08 11:13:42 -07:00
.gitignore Add build script 2022-05-08 11:13:02 -07:00
build.sh Rename to mdview 2022-05-08 16:51:04 -07:00
go.mod Rename to mdview 2022-05-08 16:51:04 -07:00
go.sum Update README 2022-05-08 17:51:59 -07:00
LICENSE Initial commit 2022-05-07 20:40:27 -07:00
main.go Update README 2022-05-08 17:51:59 -07:00
README.md Fix README 2022-05-08 17:53:43 -07:00

MdView

MdView is a tool for viewing GitHub Flavored Markdown files in your web browser. MdView recursively renders the parent directory of the user-provided file and serves its contents over HTTP on port 8080. The default browser is then launched, displaying the Markdown file as an HTML document.

Features

  • Works on Linux, Mac OS, and Windows.
  • Single executable; no installation or configuration required.
  • Preview is automatically refreshed when source files change.
  • Output supports GitHub styles, including light and dark modes.
  • Automatically skips any included front matter header data.

Usage

Simply execute MdView with the path of the Markdown file you wish to view:

$ mdview path/to/file.md

Execute MdView with --help to view options:

Usage mdview [options] [path]

Parameters:
  -port int
    	port (default 8080)

Installation

If you already have the Go environment and toolchain set up, you can get the latest version by running:

$ go get github.com/FooSoft/mdview

Otherwise, you can use the pre-built binaries from the project page.