gmitohtml-upstream/README.md

47 lines
1.3 KiB
Markdown
Raw Normal View History

2020-11-21 17:53:04 +01:00
# gmitohtml
2020-11-24 02:43:05 +01:00
[![GoDoc](https://gitlab.com/tslocum/godoc-static/-/raw/master/badge.svg)](https://docs.rocketnine.space/gitlab.com/tslocum/gmitohtml/pkg/gmitohtml)
2020-11-21 17:53:04 +01:00
[![CI status](https://gitlab.com/tslocum/gmitohtml/badges/master/pipeline.svg)](https://gitlab.com/tslocum/gmitohtml/commits/master)
[![Donate](https://img.shields.io/liberapay/receives/rocketnine.space.svg?logo=liberapay)](https://liberapay.com/rocketnine.space)
2020-11-23 02:54:44 +01:00
[Gemini](https://gemini.circumlunar.space) to [HTML](https://en.wikipedia.org/wiki/HTML)
conversion tool and daemon
2020-11-21 17:53:04 +01:00
## Download
2020-11-24 18:39:55 +01:00
[**Download gmitohtml**](https://gmitohtml.rocketnine.space/download/?sort=name&order=desc)
gmitohtml is available on Android as [Xenia](https://gitlab.com/tslocum/xenia).
2020-11-24 18:39:55 +01:00
## Compile
2020-11-21 17:53:04 +01:00
gmitohtml is written in [Go](https://golang.org). Run the following command to
download and build gmitohtml from source.
```bash
go get gitlab.com/tslocum/gmitohtml
```
The resulting binary is available as `~/go/bin/gmitohtml`.
2020-11-24 18:29:57 +01:00
## Configure
See [CONFIGURATION.md](https://gitlab.com/tslocum/gmitohtml/blob/master/CONFIGURATION.md)
2020-11-21 17:53:04 +01:00
## Usage
2020-11-23 03:32:29 +01:00
Run daemon at [http://localhost:1967](http://localhost:1967):
2020-11-21 17:53:04 +01:00
```bash
2020-11-23 03:32:29 +01:00
gmitohtml --daemon=localhost:1967
2020-11-21 17:53:04 +01:00
```
2020-11-23 03:32:29 +01:00
Convert a single document:
2020-11-21 17:53:04 +01:00
```bash
2020-11-23 03:32:29 +01:00
gmitohtml < document.gmi
2020-11-21 17:53:04 +01:00
```
## Support
Please share issues and suggestions [here](https://gitlab.com/tslocum/gmitohtml/issues).