2021-02-12 01:59:02 +00:00
|
|
|
gmi-web(1) "1.0.0-rc.2"
|
2021-01-28 06:09:49 +00:00
|
|
|
|
|
|
|
|
# NAME
|
|
|
|
|
|
2021-02-12 20:41:43 +00:00
|
|
|
gmi-web - a bridge between Gemini and HTML
|
2021-01-28 06:09:49 +00:00
|
|
|
|
|
|
|
|
# SYNOPSIS
|
|
|
|
|
|
2021-02-15 22:56:53 +00:00
|
|
|
*gmi-web* _OPTIONS_ < _FILE_
|
2021-02-12 20:41:43 +00:00
|
|
|
|
2021-02-15 22:56:53 +00:00
|
|
|
*gmi-web* _OPTIONS_ _FILES_
|
2021-01-28 17:56:02 +00:00
|
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
|
|
2021-02-15 17:17:16 +00:00
|
|
|
Convert Gemtext to semantic HTML styled in a readable, predictable and
|
|
|
|
|
mobile-friendly fashion!
|
2021-01-28 06:09:49 +00:00
|
|
|
|
2021-01-28 17:56:02 +00:00
|
|
|
# OPTIONS
|
|
|
|
|
|
2021-02-15 17:17:16 +00:00
|
|
|
*--body*
|
2021-02-15 22:31:08 +00:00
|
|
|
Generate just the HTML for the lines of the Gemini document.
|
2021-01-29 19:55:24 +00:00
|
|
|
|
2021-02-15 17:17:16 +00:00
|
|
|
*--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".
|
2021-02-12 21:59:18 +00:00
|
|
|
|
2021-02-15 17:17:16 +00:00
|
|
|
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
|
2021-02-15 22:56:53 +00:00
|
|
|
with an ellipsis at that number of characters.
|
2021-02-12 21:59:18 +00:00
|
|
|
|
2021-02-15 17:17:16 +00:00
|
|
|
Use *--author* _NAME_ to set the author <meta> tag on every file.
|
2021-01-28 17:56:02 +00:00
|
|
|
|
2021-02-15 22:31:08 +00:00
|
|
|
*--css* [_MODE_|_FILE_]
|
2021-02-15 20:56:41 +00:00
|
|
|
By default this will be set to *full* enabling a handful of customizable
|
2021-02-15 22:31:08 +00:00
|
|
|
variables. See *--help* for the complete list.
|
2021-01-29 22:32:30 +00:00
|
|
|
|
2021-02-15 17:17:16 +00:00
|
|
|
```
|
|
|
|
|
gmi-web --html en \\
|
|
|
|
|
--foreground "#555555" \\
|
|
|
|
|
--background "#9EEBCF" < doc.gmi
|
|
|
|
|
```
|
2021-01-29 06:15:23 +00:00
|
|
|
|
2021-02-15 20:56:41 +00:00
|
|
|
Choosing *core* will use just what is needed to fix vertical layout issues
|
2021-02-15 22:31:08 +00:00
|
|
|
with CSS 2.1's Normal Flow and inline elements. Pointing to a .css _FILE_
|
|
|
|
|
will use those styles.
|
2021-02-15 20:56:41 +00:00
|
|
|
|
2021-02-15 22:31:08 +00:00
|
|
|
Choosing *none* will not include any style information including when paired
|
2021-02-15 22:56:53 +00:00
|
|
|
with *--body* where it will not apply the core inline styles.
|
2021-02-15 20:56:41 +00:00
|
|
|
|
|
|
|
|
*[--image|--audio|--video]* _EXTENSIONS_
|
2021-02-15 17:17:16 +00:00
|
|
|
Include media extensions inline. You can provide multiple extensions per flag
|
|
|
|
|
or multiple flags per extension.
|
2021-01-28 17:56:02 +00:00
|
|
|
|
2021-02-15 17:17:16 +00:00
|
|
|
```
|
|
|
|
|
gmi-web --html en \\
|
|
|
|
|
--image jpg \\
|
|
|
|
|
--image png \\
|
|
|
|
|
--audio mp3 ogg < doc.gmi
|
|
|
|
|
```
|
2021-01-29 23:59:12 +00:00
|
|
|
|
2021-02-15 22:56:53 +00:00
|
|
|
*--config* _JSON_
|
2021-02-12 20:41:43 +00:00
|
|
|
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.
|
2021-01-29 23:59:12 +00:00
|
|
|
|
2021-01-28 06:09:49 +00:00
|
|
|
# AUTHORS
|
|
|
|
|
|
|
|
|
|
Maintained by Talon Poole <code@talon.computer>. Up-to-date sources can be
|
|
|
|
|
found at https://codeberg.org/talon/gmi-web
|
2021-01-28 17:56:02 +00:00
|
|
|
|
|
|
|
|
# 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/>
|
