gmi-web/README.md

113 lines
3.8 KiB
Markdown
Raw Normal View History

2020-12-11 23:22:09 +00:00
# gmi-web
2021-01-26 18:17:35 +00:00
![CC0](https://licensebuttons.net/p/zero/1.0/80x15.png)
2020-12-30 00:27:29 +00:00
2021-01-26 01:14:34 +00:00
**Vision**: Provide the lowest common denominator between HTML/CSS/JS and Gemini
2021-01-26 18:17:35 +00:00
## HTML spec
2021-01-26 01:14:34 +00:00
Due to the ambiguity of HTML several translations from Gemini exist in the wild. I propose the following standard:
```
2021-01-26 18:17:35 +00:00
<ul> ↔ *
<blockquote> ↔ >
<pre> ↔ ```
<a> ↔ =>
<h[1-3]> ↔ #[##]
<p>
2021-01-26 01:14:34 +00:00
```
2021-01-26 18:17:35 +00:00
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.
2021-01-26 01:14:34 +00:00
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).
2021-01-26 18:17:35 +00:00
`<p>`, `<ul>`, `<blockquote>` and `<pre>` may also have line-breaks which should be inserted as inner HTML using the following rules:
2021-01-26 01:14:34 +00:00
```
2021-01-26 18:17:35 +00:00
<p><br>
<blockquote><div><br></div>
<ul><li><br></li>
<pre> ↔ \n (or <br>)
2021-01-26 01:14:34 +00:00
```
These are informed by what the browser uses when `contenteditable=true` is set on the element and you hit "enter"
2021-01-26 18:17:35 +00:00
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>`.
2021-01-26 01:14:34 +00:00
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".
2021-01-26 18:17:35 +00:00
- [ ] `<head>`
- [ ] accessibility
- [ ] inline media
- [ ] pre alt text
## gmi.css
2021-01-26 01:14:34 +00:00
2021-01-26 18:17:35 +00:00
Style your HTML generated Gemini content in a readable, predicable and mobile-friendly fashion!
2021-01-26 01:14:34 +00:00
```
<meta name="color-scheme" content="dark light">
<link rel="stylesheet" href="https://talon.computer/gmi.min.css"/>
```
2021-01-26 18:17:35 +00:00
The following variables (shown with their defaults) can be customized using the style attribute of your document's `<html>` tag.
2021-01-26 01:14:34 +00:00
```
2021-01-26 18:17:35 +00:00
--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;
2021-01-26 01:14:34 +00:00
```
2021-01-26 18:17:35 +00:00
gmi.css will respect system dark mode preferences by inverting `--foreground` and `--background`.
2021-01-26 01:14:34 +00:00
```
<html style="style="--foreground:#555555; --background:#9EEBCF;">
```
2021-01-26 18:17:35 +00:00
### gmi.js
2021-01-26 01:14:34 +00:00
2021-01-26 18:17:35 +00:00
Manipulate the DOM with a Gemini inspired API.
2021-01-26 01:14:34 +00:00
```js
const line = Gemini.line("manipulate the dom\nbut like in a Gemini way\ntry it!")
document.body.prepend(line.dom)
```
2021-01-26 18:17:35 +00:00
Try changing the type and content and observing the effects.
2021-01-26 01:14:34 +00:00
```js
line.type = "UL"
line.content = "now\nit's\na\nlist"
```
2021-01-26 18:17:35 +00:00
A document provides a way to handle many lines together.
2021-01-26 01:14:34 +00:00
```js
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"
```
2021-01-26 18:17:35 +00:00
The gemtext source is available via .source
2021-01-26 01:14:34 +00:00
```js
window.gmi.source
```
All the gmi.css variables are also available as properties.
2021-01-26 18:17:35 +00:00
```js
2021-01-26 01:14:34 +00:00
let foreground = window.gmi.foreground
let background = window.gmi.background
window.gmi.foreground = background
window.gmi.background = foreground
```