gmitohtml-upstream/README.md
2021-07-10 11:19:49 -07:00

50 lines
1.3 KiB
Markdown

# gmitohtml
[![GoDoc](https://code.rocketnine.space/tslocum/godoc-static/raw/branch/master/badge.svg)](https://docs.rocketnine.space/code.rocketnine.space/tslocum/gmitohtml/pkg/gmitohtml)
[![Donate](https://img.shields.io/liberapay/receives/rocketnine.space.svg?logo=liberapay)](https://liberapay.com/rocketnine.space)
[Gemini](https://gemini.circumlunar.space) to [HTML](https://en.wikipedia.org/wiki/HTML)
conversion tool and daemon
## Download
### PC
[**Download gmitohtml**](https://gmitohtml.rocketnine.space/download/?sort=name&order=desc)
### Android
See [Xenia](https://code.rocketnine.space/tslocum/xenia).
## Compile
gmitohtml is written in [Go](https://golang.org). Run the following command to
download and build gmitohtml from source.
```bash
go get code.rocketnine.space/tslocum/gmitohtml
```
The resulting binary is available as `~/go/bin/gmitohtml`.
## Configure
See [CONFIGURATION.md](https://code.rocketnine.space/tslocum/twins/src/branch/master/CONFIGURATION.md)
## Usage
Run daemon at [http://localhost:1967](http://localhost:1967):
```bash
gmitohtml --daemon=localhost:1967
```
Convert a single document:
```bash
gmitohtml < document.gmi
```
## Support
Please share issues and suggestions [here](https://code.rocketnine.space/tslocum/gmitohtml/issues).