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-12 20:41:43 +00:00
|
|
|
*gmi-web* [--html|--body] <_OPTIONS_> < [_FILE_]
|
|
|
|
|
|
|
|
|
|
*gmi-web* [--html|--body] <_OPTIONS_> [_FILES_]
|
2021-01-28 17:56:02 +00:00
|
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
|
|
2021-01-29 19:55:24 +00:00
|
|
|
Convert Gemtext to semantic HTML styled in a readable, predictable
|
2021-01-28 06:34:23 +00:00
|
|
|
and mobile-friendly fashion!
|
2021-01-28 06:09:49 +00:00
|
|
|
|
2021-01-28 17:56:02 +00:00
|
|
|
# OPTIONS
|
|
|
|
|
|
2021-02-12 20:41:43 +00:00
|
|
|
*--html* _LANG_
|
|
|
|
|
Generate a full HTML5 document with the provided _LANG_.
|
2021-01-29 19:55:24 +00:00
|
|
|
|
2021-02-12 20:41:43 +00:00
|
|
|
*gmi-web* --html en < doc.gmi
|
2021-01-29 19:55:24 +00:00
|
|
|
|
2021-02-12 21:59:18 +00:00
|
|
|
*--descriptions*
|
|
|
|
|
If this flag is set the first non-empty text line of each Gemini file will
|
|
|
|
|
be used for the description <meta> tag. This will be truncated to 200
|
|
|
|
|
characters using an ellipsis.
|
|
|
|
|
|
|
|
|
|
*--author*
|
|
|
|
|
If provided this will be used for the author <meta> tag on every file.
|
|
|
|
|
|
2021-02-12 20:41:43 +00:00
|
|
|
*--body*
|
|
|
|
|
Generate only the HTML for the lines of the Gemini document.
|
2021-01-29 00:24:22 +00:00
|
|
|
|
2021-02-12 20:41:43 +00:00
|
|
|
*gmi-web* --body < doc.gmi
|
2021-01-28 17:56:02 +00:00
|
|
|
|
2021-02-12 20:41:43 +00:00
|
|
|
*--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>.
|
2021-01-30 16:32:44 +00:00
|
|
|
|
2021-02-12 20:41:43 +00:00
|
|
|
*gmi.css*
|
|
|
|
|
See --help or gmi.css(5) for the complete list of customizable styles.
|
2021-01-29 22:32:30 +00:00
|
|
|
|
2021-02-12 20:41:43 +00:00
|
|
|
*gmi-web* --html en --foreground "#555555" --background "#9EEBCF" < doc.gmi
|
2021-01-29 06:15:23 +00:00
|
|
|
|
2021-02-12 20:41:43 +00:00
|
|
|
*[--image|--audio|--video]* _EXENSIONS_
|
|
|
|
|
Include the provided _EXTENSIONS_ as inline media according to the flag used.
|
|
|
|
|
You can provide multiple extensions per flag or multiple flags per extension.
|
2021-01-28 17:56:02 +00:00
|
|
|
|
2021-02-12 20:41:43 +00:00
|
|
|
*gmi-web* --image jpg png --audio mp3 --html en < doc.gmi
|
2021-01-29 23:59:12 +00:00
|
|
|
|
2021-02-12 20:41:43 +00:00
|
|
|
*gmi-web* --image jpg --image png --audio mp3 --html en < doc.gmi
|
2021-01-29 23:59:12 +00:00
|
|
|
|
2021-02-12 20:41:43 +00:00
|
|
|
*--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.
|
2021-01-29 23:59:12 +00:00
|
|
|
|
2021-02-12 20:41:43 +00:00
|
|
|
*gmi-web* --config web.json < doc.gmi
|
2021-01-29 23:59:12 +00:00
|
|
|
|
2021-01-29 19:55:24 +00:00
|
|
|
# SEE ALSO
|
2021-01-28 17:56:02 +00:00
|
|
|
|
2021-01-29 19:55:24 +00:00
|
|
|
*gmi.css*(5)
|
2021-01-28 17:56:02 +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/>
|
