Go to file

Alex Yatskov 9f944be1d2 Update for goldsmith		2024-03-14 22:13:50 -07:00
css	Cleanup	2022-05-08 11:13:42 -07:00
.gitignore	Add build script	2022-05-08 11:13:02 -07:00
LICENSE	Initial commit	2022-05-07 20:40:27 -07:00
README.md	Update MdView link	2023-12-30 14:22:05 -08:00
go.mod	Update for goldsmith	2024-03-14 22:13:50 -07:00
go.sum	Update for goldsmith	2024-03-14 22:13:50 -07:00
main.go	Update for goldsmith	2024-03-14 22:13:50 -07:00

README.md

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

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)