gmi-web/gmi-web.1.scd

gmi-web(1)

# NAME

gmi-web - A bridge between Gemini and HTML

# SYNOPSIS

*gmi-web* _OPTIONS_ < _FILE_

*gmi-web* _OPTIONS_ _FILES.._

# DESCRIPTION 

Convert Gemtext to semantic HTML styled in a readable and mobile-friendly 
fashion!

# OPTIONS

*--body*
	Generate just the HTML blocks for the lines of the Gemini document.

*--html* _LANG_
	Generate a full HTML5 document with the provided _LANG_. *--dir* can be used
	to adjust the document text direction from "ltr" to "rtl".

	Use *--author* _NAME_ to set the author <meta> tag on every file.

	Use *--descriptions* [_LIMIT_] to apply the first non-empty text line of each
	file as the description <meta> tag. _LIMIT_ may be used to truncate the text
	with an ellipsis at that number of characters.

*--css* _MODE_|_FILE_
	*--html* will default _MODE_ to *full* enabling a handful of font and color 
	variables. See *--help* for the complete list.

```
gmi-web --html en \\ 
	--foreground "#555555" \\
	--background "#9EEBCF" < doc.gmi
```

	*--body* will default _MODE_ to *core* and use just what is needed to fix 
	CSS Normal Flow quirks. 

	Pointing to a CSS _FILE_ will use those styles. This works with *--body* or
	*--inline*.

	*--inline* will insert the declarations as "style" properties on their 
	respective blocks. This is the only behavior when using *--body*.

	Choosing *none* will not include any style information. 

*--image|--audio|--video* _EXTENSIONS_
	Include media extensions inline. You can provide multiple extensions per flag
	or multiple flags per extension.

```
gmi-web --html en \\
	--image jpg \\
	--image png \\
	--video mp4 \\
	--audio mp3 ogg < doc.gmi
```

*--config* _JSON_
	All the options documented here and by *--help* may be captured in a .json
	file and passed to *--config* instead of as flags on the command-line.

# AUTHORS

Maintained by Talon Poole <code@talon.computer>. Up-to-date sources can be 
found at https://codeberg.org/talon/gmi-web

# COPYRIGHT
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>