gmi-web/gmi-web.1.scd

gmi-web(1) "1.0.0-rc.2"

# NAME

gmi-web - a bridge between Gemini and HTML

# SYNOPSIS

*gmi-web* [--html _LANG_|--body] <_OPTIONS_> < [_FILE_]

*gmi-web* [--html _LANG_|--body] <_OPTIONS_> [_FILES_]

# DESCRIPTION 

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

# OPTIONS

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

```
gmi-web --body < doc.gmi
```

*--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 *--descriptions* _LIMIT_ to apply the first non-empty text line of each
	file as the description <meta> tag. _LIMIT_ will be used to truncate the text
	with an ellipsis at that number of characters, otherwise the whole line will 
	be used.

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

*--css* _MODE_
	By default this will be set to *gmi.css*. Choosing *base* will use just what
	is needed to fix issues with CSS 2.1's Normal Flow. Choosing *none* will not
	include any style information and inline elements will be wrapped in <p>. 

*gmi.css*
	See --help or gmi.css(5) for the complete list of customizable styles.

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

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

```
gmi-web --html en \\
	--image jpg \\
	--image png \\
	--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.

# SEE ALSO

*gmi.css*(5)

# 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/>