Skip to content

zyfdegh/mdviewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdviewer

Build Status

Go Report

Mdviewer logo

Mdviewer(mdv) is a markdown server, it displays markdown files in your broswer.

Run

git clone https://github.com/zyfdegh/mdviewer.git
go get github.com/russross/blackfriday
cd mdviewer && ./build.sh
cd bin && ./mdv ../README.md

Open your favourite web browser and type:

127.0.0.1:8080

README.md should be styled and displayed in the web page.

Add to PATH

If you feel good and want to use 'mdv' command in system wide, copy bin/* to $PATH.

For Unix/Linux/MacOS:

cp bin/* /usr/local/bin

For Windows:

copy bin\* C:\Windows\System32\

For better experience

Install broswer plugin like Auto-Refresh to refresh web page automatically if you're using Google Chrome.

Thanks

This project was mainly inspired by ryanuber/readme-server

Related

Call-web-broswer: Call system default web browser to open a url zyfdegh/call-web-broswer.

About

View markdown file in web browser.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published