mdview

README

Markdown Viewer

Open Markdown files using the default web browser for preview.

The sole purpose of this program is to provide an idea of how Markdown files will display when viewed on sites like GitHub.

Supported Formats

• Original Markdown
• GitHub Flavored Markdown

Installation

Requirements: Go 1.16+.

To install, run:

go install github.com/julianolf/mdview@latest

Usage

Preview a single file:

mdview file.md

You can open multiple files for preview:

mdview file1.md file2.md

Or use wildcards:

mdview *.md

For more information, run:

mdview -h

Credits

• Markdown parser: goldmark
• Browser helpers: browser
• CSS: github-markdown-css