Skip to content

gedex/preview-github-readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Preview Github README.md

The preview that mimics repo's homepage in GitHub.

Requirements

How to use

$ go get github.com/gedex/preview-github-readme
$ preview-github-readme README.md           # Will output generated HTML into stdout
$ preview-github-readme /my/repo/readme.md  # Works on any path

Pipes it to browser:

$ preview-github-readme README.md | browser

or:

$ preview-github-readme --serve 8080 README.md # Previewer is available on http://localhost:8080

About

Go app to preview your GitHub's README.md

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages