specter/gmi-web
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

ship it

Browse source
This commit is contained in:
Talon Poole 2021-02-15 23:07:42 +00:00
parent 965195afe3
commit 5a575f24db
4 changed files with 43 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

68
README.md
View file

@ -11,12 +11,12 @@ This repo is home to:
The converted Gemini document should exist inside the `<body>`. Consider if sharing the page with other HTML to put the core document inside `<main>`. Each available line-type may be translated using the following guide:
````
<p> ↔
<a> ↔ =>
<pre> ↔ ```
<h[1-3]> ↔ #[##]
<li> ↔ *
<blockquote> ↔ >
<p> ↔
<a> ↔ =>
<pre> ↔ ```
<h[1-3]> ↔ #[##]
<li> ↔ *
<blockquote> ↔ >
````
List items must be wrapped with a `<ul>` tag. Empty lines should be represented as `<p><br></p>`. Take care to render `<pre>` blocks with their original formatting, DO NOT indent the generated
@ -63,45 +63,55 @@ 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
HTML:
--author [string]
--descriptions [number] [default: 0]
--css [default: "full"]
--dir [string] [choices: "rtl", "ltr"] [default: "ltr"]
Inline Media:
--image [array]
--audio [array]
--video [array]
CSS:
--body-width [default: "48rem"]
--foreground [default: "black"]
--background [default: "white"]
--p-size [default: "1.25rem"]
--p-indent [default: "0rem"]
--p-line-height [default: "1.5"]
--a-size [default: "var(--p-size)"]
--pre-size [default: "1rem"]
--pre-line-height [default: "1"]
--h1-size [default: "3rem"]
--h2-size [default: "2.25rem"]
--h3-size [default: "1.5rem"]
--heading-line-height [default: "1.25"]
--ul-size [default: "var(--p-size)"]
--ul-line-height [default: "1.25"]
--blockquote-size [default: "var(--p-size)"]
--blockquote-line-height [default: "1.25"]
--mono [default: "Consolas, monaco, monospace"]
--serif [default: "georgia, times, serif"]
--sans-serif
[default: "-apple-system, BlinkMacSystemFont, "avenir next", avenir,
helve
tica, "helvetica neue", ubuntu, roboto, noto, "segoe ui", arial,
sans-seri
f"]
Options:
--version Show version number [boolean]
--config Path to JSON config file
--help Show help [boolean]
Examples:
gmi-web --body < ~/my-capsule/index.gmi
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

2
cli.js
View file

@ -72,7 +72,7 @@ const cli = yargs(process.argv.slice(2))
},
})
.group(["html", "body"], "Core:")
.group(["author", "descriptions", "css", "mode", "dir"], "HTML:")
.group(["author", "descriptions", "css", "modes", "dir"], "HTML:")
.group(["image", "audio", "video"], "Inline Media:");
const CSS_VARS = CSS.rootVariables(CSS.FULL);
Object.keys(CSS_VARS).map((key) => {

2
gmi-web.1.scd
View file

@ -1,4 +1,4 @@
gmi-web(1) "1.0.0-rc.2"
gmi-web(1) "1.0.2-rc.2"
# NAME

4
package.json
View file

@ -1,6 +1,6 @@
{
"name": "gmi-web-cli",
"version": "1.0.1-rc.2",
"version": "1.0.2-rc.2",
"description": "A bridge between HTML and Gemini",
"main": "html.js",
"type": "module",
@ -15,9 +15,9 @@
"UNLICENSE",
"README.md",
"gmi-web.1",
"gmi.css.5",
"gmi.css",
"html.js",
"css.js",
"cli.js"
],
"scripts": {