Convert text/gemini to text/html

Go to file

Talon Poole 66672e530e update README		2021-01-26 18:17:35 +00:00
.gitignore	markdown docs	2021-01-26 01:14:34 +00:00
gmi.css	light/dark mode	2021-01-26 00:54:35 +00:00
gmi.js	Update docs + preliminary editablity	2020-12-30 00:27:29 +00:00
Makefile	Gemini.line shorthand API and repo cleanup	2020-12-29 23:02:43 +00:00
README.md	update README	2021-01-26 18:17:35 +00:00

README.md

gmi-web

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

HTML spec

Due to the ambiguity of HTML several translations from Gemini exist in the wild. I propose the following standard:

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

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> and also Gemini has no "empty" line-type just a line that is empty.

The <a> for a link should be presented without any parent elements. Many implementations use <div> 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 and when parsing. If you must wrap the link it should be with a <p> tag and never a <div>. If you do not wrap the link a simple a {display: block} has the same effect (gmi.css uses this).

<p>, <ul>, <blockquote> and <pre> may also have line-breaks which should be inserted as inner HTML using the following rules:

<p>          ↔ <br>
<blockquote> ↔ <div><br></div>
<ul>         ↔ <li><br></li>
<pre>        ↔ \n (or <br>)

These are informed by what the browser uses when contenteditable=true is set on the element and you hit "enter"

Some implementations render a series of > into a series of <blockquotes> which is probably fine but it is semantically preferable to group them and insert the subsequent lines as <div>line-breaks</div>.

Parsers may want to be aware of potential <br> lines inside <pre> tags as that is how "enter" is handled when contenteditable=true. It is uncertain why the browser behaves so but they can be safely translated to \n. and you need not translate \n → <br> as that's implied in "preformatted".

<head>
accessibility
inline media
pre alt text

gmi.css

Style your HTML generated Gemini content in a readable, predicable and mobile-friendly fashion!

<meta name="color-scheme" content="dark light">
<link rel="stylesheet" href="https://talon.computer/gmi.min.css"/>

The following variables (shown with their defaults) can be customized using the style attribute of your document's <html> tag.

--foreground: black;
--background: white;
--line-height: 1.5;
--font-size: 1.25rem;
--mono: Consolas, monaco, monospace;
--serif: font-family: georgia, times, serif;
--sans-serif: -apple-system, BlinkMacSystemFont,
             'avenir next', avenir,
             helvetica, 'helvetica neue',
             ubuntu,
             roboto, noto,
             'segoe ui', arial,
             sans-serif;

gmi.css will respect system dark mode preferences by inverting --foreground and --background.

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

gmi.js

Manipulate the DOM with a Gemini inspired API.

const line = Gemini.line("manipulate the dom\nbut like in a Gemini way\ntry it!")
document.body.prepend(line.dom)

Try changing the type and content and observing the effects.

line.type = "UL"
line.content = "now\nit's\na\nlist"

A document provides a way to handle many lines together.

window.gmi = new Gemini(document.body)
window.gmi.lines = [
  Gemini.line("interesting", "H1"),
  Gemini.line("that's convenient"),
  Gemini.line("http://talon.computer/js/ now... take me back please", "A"),
]
window.gmi.lines[0].type = "H3"

The gemtext source is available via .source

window.gmi.source

All the gmi.css variables are also available as properties.

let foreground = window.gmi.foreground
let background = window.gmi.background
window.gmi.foreground = background
window.gmi.background = foreground