From 5a575f24db1e16740d1245d11c5536061a46d66e Mon Sep 17 00:00:00 2001 From: Talon Poole Date: Mon, 15 Feb 2021 23:07:42 +0000 Subject: [PATCH] ship it --- README.md | 68 +++++++++++++++++++++++++++++---------------------- cli.js | 2 +- gmi-web.1.scd | 2 +- package.json | 4 +-- 4 files changed, 43 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 529880b..96d3493 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,12 @@ This repo is home to: The converted Gemini document should exist inside the ``. Consider if sharing the page with other HTML to put the core document inside `
`. Each available line-type may be translated using the following guide: ```` -

↔ - ↔ => -

          ↔   ```
-       ↔   #[##]
-
  • ↔ * -
    ↔ > +

    ↔ + ↔ => +

             ↔  ```
    +      ↔  #[##]
    +
  • ↔ * +
    ↔ > ```` List items must be wrapped with a `
      ` tag. Empty lines should be represented as `


      `. Take care to render `
      ` 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
      diff --git a/cli.js b/cli.js
      index c1e45f3..0f837e1 100755
      --- a/cli.js
      +++ b/cli.js
      @@ -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) => {
      diff --git a/gmi-web.1.scd b/gmi-web.1.scd
      index 1afb41b..dc941a6 100644
      --- a/gmi-web.1.scd
      +++ b/gmi-web.1.scd
      @@ -1,4 +1,4 @@
      -gmi-web(1) "1.0.0-rc.2"
      +gmi-web(1) "1.0.2-rc.2"
       
       # NAME
       
      diff --git a/package.json b/package.json
      index 3d771e4..d6a6cf4 100644
      --- a/package.json
      +++ b/package.json
      @@ -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": {