https://github.com/pocke/gfm-viewer

gfm-viewer is GitHub Flavored markdown Viewer.
https://github.com/pocke/gfm-viewer

Last synced: about 2 months ago
JSON representation

gfm-viewer is GitHub Flavored markdown Viewer.

• Host: GitHub
• URL: https://github.com/pocke/gfm-viewer
• Owner: pocke
• License: mit
• Created: 2015-06-02T08:39:16.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-08-23T09:40:10.000Z (over 9 years ago)
• Last Synced: 2024-06-19T05:54:35.418Z (6 months ago)
• Language: Go
• Homepage:
• Size: 1.53 MB
• Stars: 9
• Watchers: 3
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
gfm-viewer

==============

[![Build Status](https://travis-ci.org/pocke/gfm-viewer.svg?branch=master)](https://travis-ci.org/pocke/gfm-viewer)

[![Coverage Status](https://coveralls.io/repos/pocke/gfm-viewer/badge.svg?branch=travis)](https://coveralls.io/r/pocke/gfm-viewer?branch=travis)

gfm-viewer is GitHub Flavored markdown Viewer.

Installation

-----------------

### If you download binary(64bit Linux only).

You download binary from [latest release](https://github.com/pocke/gfm-viewer/releases/latest), and place it in `$PATH` directory.

### Or if build yourself.

```sh

go get -d github.com/pocke/gfm-viewer

cd $GOPATH/src/github.com/pocke/gfm-viewer/

make depends && make install

```

Usage

----------

```sh

gfm-viewer FILENAME1 FILENAME2 ...

```

Automatically opens the browser.

Parsed markdown is opened by click filename.

If you save file, automatically parse and reload.

### Screen Shot

![ScreenShot](screen_shot.png)

![ScreenShot](screen_shot.gif)

Supports

-----------

- Linux

Maybe, it works on other OS.

But I do not have OS other than Linux. So, I can't check of operation on other OS.

Links

---------

- [Markdown ビューワをリリースした - pockestrap (Japanese Blog)](http://pocke.hatenablog.com/entry/2015/06/10/135943)

License

-------------

Copyright © 2015 Masataka Kuwabara

Licensed [MIT][mit]

[MIT]: http://www.opensource.org/licenses/mit-license.php