gmi-web

Vision: Provide the lowest common denominator between HTML/CSS/JS and Gemini.

HTML spec

`<head>`

The generated HTML document must have a <head> tag with at minimum the following:

<head>
  <meta name="viewport" content="width=device-width,initial-scale=1" />
  <!-- set these accordingly -->
  <meta charset="utf-8" />
  <meta language="en" />
  <title></title>
</head>

You might want to also include these (or whatever else):

<link rel="canonical" href="gemini://" />
<meta name="description" content="" />

`<body>`

The converted Gemini document should be placed inside the <body>. Due to the ambiguity of HTML several translations from Gemini exist in the wild. I propose the following standard:

<p>
<a>            ↔ =>
<pre>          ↔ ```
<h[1-3]>       ↔ #[##]
<li>           ↔ *
<blockquote>   ↔ >

is the
required or desired?

Much like the lines of a <pre>, the lines of <li>list items</li> need to be wrapped in <ul>, indention here is not significant. Sometimes a list item is empty: <li><br></li>.

Empty lines should simply be represented as <p><br></p> this sets up contenteditable=true to add content to the line compared to just <br>.

Take care to render <pre> blocks with their original formatting, DO NOT indent the generated HTML for these tags.

block vs inline elements

The <a> for a link should be presented un-wrapped without any parent elements. Many implementations use <div> or <p> to enforce "block" styling as opposed to the default "inline" which renders the link next to the previous block instead of below it. But the nested markup adds an unnecessary layer of indirection in semantics. The best way to handle this is to include <style>a {display: block;}</style> in the <head>.

Optional: inline media

what media can I inline?

If a link is consumable by <img>, <audio> or <video> you may insert the respective tag inline instead of an <a>. Images and video should be styled to have max-width: 100%; so they don't overflow the body. It's a good idea to also include the "controls" attribute. <audio> tags require display: block; just like <a>.

Basic `<style>`

Without any CSS the browser renders all of this just a lil wonky. At bare minimum I recommend including the following in the <head> of all your generated .html files.

<style>
  p,
  a,
  pre,
  h1,
  h2,
  h3,
  ul,
  blockquote,
  img,
  audio,
  video {
    display: block;
    max-width: 100%;
    margin: 0;
    padding: 0;
    overflow-wrap: anywhere;
  }
</style>

gmi-web(1)

Currently approaching a v1 release 🎉 Would you like to help test the RC? You will need: node(1) w/ npm(1)

npm install --global gmi-web-cli

gmi-web [files..]

Convert text/gemini to text/html.

Core:
  --html, --language, --lang                                            [string]
  --css                [choices: "gmi.css", "base", "none"] [default: "gmi.css"]
  --body                                                               [boolean]

gmi.css:
  --body-width
  --foreground
  --background
  --p-size
  --p-indent
  --p-line-height
  --a-size
  --pre-size
  --pre-line-height
  --h1-size
  --h2-size
  --h3-size
  --heading-line-height
  --ul-size
  --ul-line-height
  --blockquote-size
  --blockquote-line-height
  --mono
  --serif
  --sans-serif

Inline Media:
  --image                                                                [array]
  --audio                                                                [array]
  --video                                                                [array]

Options:
  --version  Show version number                                       [boolean]
  --config   Path to JSON config file
  --help     Show help                                                 [boolean]

Examples:
  gmi-web --html en $(find ~/my-capsule -name '*.gmi')
  gmi-web --foreground '#000000' --background '#EEEEEE' --html en < doc.gmi
  gmi-web --body < ~/my-capsule/index.gmi
  gmi-web --image jpg --audio mp3 --image png --body < doc.gmi

See the gmi-web(1) man page for more information

gmi.css

Optimized for readability, predictability and mobile-friendliness. Ships with a handful of customizable variables. See man 5 gmi.css.

The --foreground and --background variables will be inverted when prefers-color-scheme is "dark" which is a system-level preference on devices.

Any of the variables can be customized by adding a style to the <html> element.

<html style="--foreground:#555555; --background:#9EEBCF;"></html>

When using gmi-web(1) they can be customized via flags on the command-line.

gmi-web --foreground "#FFFFF" --background "#00000" --lang "en" $(find . -name "*.gmi")

License

gmi-web is free and unencumbered public domain software. For more information, see http://unlicense.org/ or the accompanying UNLICENSE file.

4.9 KiB Raw Blame History

gmi-web

HTML spec

<head>

<body>