https://github.com/gilliek/ghmd
Simple CLI tool written in Go that renders GitHub Markdown files using the GitHub API.
https://github.com/gilliek/ghmd
cli github go golang markdown
Last synced: about 1 year ago
JSON representation
Simple CLI tool written in Go that renders GitHub Markdown files using the GitHub API.
- Host: GitHub
- URL: https://github.com/gilliek/ghmd
- Owner: gilliek
- License: other
- Created: 2014-04-28T10:01:56.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2015-06-28T21:27:02.000Z (almost 11 years ago)
- Last Synced: 2025-04-03T04:51:11.229Z (about 1 year ago)
- Topics: cli, github, go, golang, markdown
- Language: Go
- Homepage:
- Size: 259 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ghmd
====
Simple Go CLI tool that renders GitHub Markdown files using the GitHub API.
Compatibility
-------------
It should work on any system supported by Go. For now, I only tested on Linux but if you use it on another system, feel free to update this README and send me a pull request :)
Build
-----
The only required dependency is Go. Although it should work with any version of Go, I only have tested with Go1.2.
You can get and build `ghmd` by issuing the following command:
```
go get github.com/gilliek/ghmd
```
(make sure your `$GOPATH` is correctly set)
Download binary
---------------
If you want to download a binary file, you can use the [Gobuild.IO](http://gobuild.io/download/github.com/gilliek/ghmd) service.
Linux packages
--------------
### Archlinux
[AUR package](https://aur.archlinux.org/packages/ghmd-bin) (thanks to [Rolinh](https://github.com/Rolinh) for maintaining the package).
Usage
-----
Assuming that `ghmd` is in your `$PATH`:
```
ghmd README.md
```
You can also use the `-w` switch to automatically update the generated HTML file when the `README.md` is modified:
```
ghmd -w README.md
```
For a full description of the options, please use:
```
ghmd -h
```