gmi-web/gmi-web.1.scd
2021-02-02 22:09:03 +00:00

97 lines
2.5 KiB
Markdown

gmi-web(1) "1.0.7-rc.1"
# NAME
gmi-web - A bridge between Gemini and HTML.
# SYNOPSIS
*gmi-web* [--lang] <_OPTIONS_> [_FILES_]
# DESCRIPTION
Convert Gemtext to semantic HTML styled in a readable, predictable
and mobile-friendly fashion!
# OPTIONS
*--lang*
Required for <meta languge="">
*CSS Variables*
Any variable documented in *gmi.css*(5) can be set via _OPTIONS_ of the same
name.
*gmi-web* --lang "en" --foreground "#FFFFF" --background "#00000" $(find . -name \*.gmi)
*--images* *--audio* *--video*
Include the respective media inline.
*--no-css*
Use only the bare minimum <style>
*--config* [_JSON_]
All the options documented here and by *--help* may be captured in a .json
file and passed to *--config*.
# EXAMPLES
Render .html for all the .gmi files in the current directory
```
gmi-web --lang en $(find . -name "\*.gmi")
```
To use *--config* you will need a .json file with the flags you want to be
included.
```
{
"language": "en",
"foreground": "#137752",
"background": "#F4F4F4"
}
```
Then give the path to *gmi-web* --config.
```
gmi-web --config /path/to/my.json $(find . -name "\*.gmi")
```
# 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/>