ship it
This commit is contained in:
Talon Poole
parent
965195afe3
commit
5a575f24db
68
README.md
68
README.md
|
|
@ -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:
|
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> ↔
|
<p> ↔
|
||||||
<a> ↔ =>
|
<a> ↔ =>
|
||||||
<pre> ↔ ```
|
<pre> ↔ ```
|
||||||
<h[1-3]> ↔ #[##]
|
<h[1-3]> ↔ #[##]
|
||||||
<li> ↔ *
|
<li> ↔ *
|
||||||
<blockquote> ↔ >
|
<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
|
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:
|
Core:
|
||||||
--html, --language, --lang [string]
|
--html, --language, --lang [string]
|
||||||
--css [choices: "gmi.css", "base", "none"] [default: "gmi.css"]
|
|
||||||
--body [boolean]
|
--body [boolean]
|
||||||
|
|
||||||
gmi.css:
|
HTML:
|
||||||
--body-width
|
--author [string]
|
||||||
--foreground
|
--descriptions [number] [default: 0]
|
||||||
--background
|
--css [default: "full"]
|
||||||
--p-size
|
--dir [string] [choices: "rtl", "ltr"] [default: "ltr"]
|
||||||
--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:
|
Inline Media:
|
||||||
--image [array]
|
--image [array]
|
||||||
--audio [array]
|
--audio [array]
|
||||||
--video [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:
|
Options:
|
||||||
--version Show version number [boolean]
|
--version Show version number [boolean]
|
||||||
--config Path to JSON config file
|
--config Path to JSON config file
|
||||||
--help Show help [boolean]
|
--help Show help [boolean]
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
gmi-web --body < ~/my-capsule/index.gmi
|
||||||
gmi-web --html en $(find ~/my-capsule -name '*.gmi')
|
gmi-web --html en $(find ~/my-capsule -name '*.gmi')
|
||||||
gmi-web --foreground '#000000' --background '#EEEEEE' --html en < doc.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
|
gmi-web --image jpg --audio mp3 --image png --body < doc.gmi
|
||||||
|
|
||||||
See the gmi-web(1) man page for more information
|
See the gmi-web(1) man page for more information
|
||||||
|
|
|
||||||
2
cli.js
2
cli.js
|
|
@ -72,7 +72,7 @@ const cli = yargs(process.argv.slice(2))
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
.group(["html", "body"], "Core:")
|
.group(["html", "body"], "Core:")
|
||||||
.group(["author", "descriptions", "css", "mode", "dir"], "HTML:")
|
.group(["author", "descriptions", "css", "modes", "dir"], "HTML:")
|
||||||
.group(["image", "audio", "video"], "Inline Media:");
|
.group(["image", "audio", "video"], "Inline Media:");
|
||||||
const CSS_VARS = CSS.rootVariables(CSS.FULL);
|
const CSS_VARS = CSS.rootVariables(CSS.FULL);
|
||||||
Object.keys(CSS_VARS).map((key) => {
|
Object.keys(CSS_VARS).map((key) => {
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
gmi-web(1) "1.0.0-rc.2"
|
gmi-web(1) "1.0.2-rc.2"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "gmi-web-cli",
|
"name": "gmi-web-cli",
|
||||||
"version": "1.0.1-rc.2",
|
"version": "1.0.2-rc.2",
|
||||||
"description": "A bridge between HTML and Gemini",
|
"description": "A bridge between HTML and Gemini",
|
||||||
"main": "html.js",
|
"main": "html.js",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
|
|
@ -15,9 +15,9 @@
|
||||||
"UNLICENSE",
|
"UNLICENSE",
|
||||||
"README.md",
|
"README.md",
|
||||||
"gmi-web.1",
|
"gmi-web.1",
|
||||||
"gmi.css.5",
|
|
||||||
"gmi.css",
|
"gmi.css",
|
||||||
"html.js",
|
"html.js",
|
||||||
|
"css.js",
|
||||||
"cli.js"
|
"cli.js"
|
||||||
],
|
],
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue