2020-12-11 23:22:09 +00:00
# gmi-web
2021-01-28 06:16:46 +00:00
2021-01-28 00:35:07 +00:00
**Vision**: Provide the lowest common denominator between HTML/CSS/JS and Gemini.
2021-01-26 01:14:34 +00:00
2021-01-26 18:17:35 +00:00
## HTML spec
2021-01-26 22:29:24 +00:00
2021-01-28 04:12:11 +00:00
Check out the annotated [example.html ](https://gmi.eattherich.club/example.html )!
2021-01-26 22:29:24 +00:00
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-28 06:16:46 +00:00
````
2021-01-26 18:17:35 +00:00
< ul > ↔ *
< blockquote > ↔ >
2021-01-28 06:16:46 +00:00
< pre > ↔ ```
< a > ↔ =>
2021-01-26 18:17:35 +00:00
< h [ 1-3 ] > ↔ #[##]
< p >
2021-01-28 06:16:46 +00:00
````
2021-01-26 01:14:34 +00:00
2021-01-28 00:35:07 +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. `<a style="display: block;">` has the same effect (gmi.css uses this).
2021-01-26 22:29:24 +00:00
2021-01-28 04:12:11 +00:00
### inline media
2021-01-28 17:56:02 +00:00
Optionally, if a link is consumable by `<img>` , `<audio>` or `<video>` you may insert the media inline. 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 for videos and audio. `<audio>` tags require `display: block;` just like `<a>` .
2021-01-28 04:12:11 +00:00
2021-01-26 22:29:24 +00:00
### contenteditable
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>` .
When `contenteditable=true` , `<p>` , `<ul>` , `<blockquote>` and `<pre>` may also have line-breaks which will be represented in `.innerHTML` like so:
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
```
2021-01-26 22:29:24 +00:00
This is important mostly for DOM development (as opposed to static HTML generation) where it is likely to occur.
2021-01-26 01:14:34 +00:00
2021-01-26 18:17:35 +00:00
## gmi.css
2021-01-26 01:14:34 +00:00
2021-01-28 04:12:11 +00:00
Style your HTML generated Gemini content in a readable, predictable 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-28 04:12:11 +00:00
--foreground: black;
--background: white;
--p-size: 1.25rem;
--p-indent: 0rem;
--a-size: var(--p-size);
--pre-size: 1rem;
--h1-size: 3rem;
--h2-size: 2.25rem;
--h3-size: 1.5rem;
--ul-size: var(--p-size);
--blockquote-size: var(--p-size);
--mono: Consolas, monaco, monospace;
--serif: 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
```
2021-01-28 04:12:11 +00:00
< html style = "--foreground:#555555; --background:#9EEBCF;" >
2021-01-26 01:14:34 +00:00
```
2021-01-28 17:56:02 +00:00
## gmi-web(1)
```
2021-01-28 23:07:57 +00:00
gmi-web [--no-css] [files..]
2021-01-28 17:56:02 +00:00
2021-01-28 23:07:57 +00:00
Convert .gmi to .html. See gmi-web(1) for more details.
2021-01-28 17:56:02 +00:00
Positionals:
2021-01-28 23:07:57 +00:00
files .gmi files to convert to .html [required]
2021-01-28 17:56:02 +00:00
Options:
2021-01-28 23:07:57 +00:00
--version Show version number [boolean]
--help Show help [boolean]
--css Toggle inclusion of gmi.css. [boolean] [default: true]
2021-01-28 17:56:02 +00:00
```
*You will need*:
- [node(1) (w/ npm(1)) ](https://nodejs.org/en/ ) (to build/run the cli)
- [scdoc(1) ](https://git.sr.ht/~sircmpwn/scdoc ) (for the man pages)
```sh
make install
```
2021-01-28 00:35:07 +00:00
<!-- TODO
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
```
2021-01-28 00:35:07 +00:00
-->
2021-01-28 17:56:02 +00:00
### License
gmi-web is free and unencumbered public domain software. For more information, see http://unlicense.org/ or the accompanying UNLICENSE file.
