https://github.com/gedex/preview-github-readme
Go app to preview your GitHub's README.md
https://github.com/gedex/preview-github-readme
Last synced: over 1 year ago
JSON representation
Go app to preview your GitHub's README.md
- Host: GitHub
- URL: https://github.com/gedex/preview-github-readme
- Owner: gedex
- Created: 2013-06-17T12:19:24.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2014-12-03T02:28:09.000Z (over 11 years ago)
- Last Synced: 2025-02-15T08:24:43.556Z (over 1 year ago)
- Language: Go
- Size: 199 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Preview Github README.md
========================
The preview that mimics repo's homepage in [GitHub](https://github.com).
## Requirements ##
* Go 1.1
* Internet so `&http.Client{}` can make a request to https://api.github.com/markdown/raw
## 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
````