jekyll-theme-modootoday 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9eb1c4e782cdbaba12079575f273b74a14e9a0e701139858cbf72bf665409d2d
-  data.tar.gz: 41b86c06c720c2ca4077aed45c2e1cf8457aa2774630ffc3e28c8e8aa1041afa
+  metadata.gz: ba068af52c4217d7469bbaf5d086362b4704281f9a3ce7b9a96ca826e66c6f11
+  data.tar.gz: ea56a35d36bbb798fabe491a206314227f6253f0228370f62330a3bb0f4aa040
 SHA512:
-  metadata.gz: fd67889b39a19ad4d5e462543d8eb237d8e5823a2713aeeb9d7189d72ab71bbaf252f83e97a406edfb75ba760b822d9137bd211d8670f8cd47264d39a9c6d197
-  data.tar.gz: b7185e039610c3d5641eb29bf34a91bc436bdf3113645dd4ed07036e5d2d55d388bb1ffc74ea932d2ad0c88e70235ac2c123f45a002f902f5da2b3abde263dcf
+  metadata.gz: 9cb0516b1496e14dc54c91c99f08b490eb3b314f62e1946e647a02d9377f7f19331d3ac979ab483285a97b4322eedd28168b1cc7483ea798596d61578a1c2b2a
+  data.tar.gz: 33f345936a60b53e2097eb4a6177bf6490f43711143584fd361ad6caa2ac8a93497efa5ee8f9de85f44441195154ceefefd4f1048f0545c5dda8bc451f09f80d

data/CHANGELOG.md

@@ -6,6 +6,24 @@ The content rules have their own version header (`md-components v1`) in [RULES.m
 
 ## [Unreleased]
 
+## [1.4.1] - 2026-10-31
+
+### Fixed
+
+- Markdown twins and `llms-full.txt` now include a `reference` page's `packages:` table as a Markdown table (with `packages_title`, before or after the body as `packages_position` sets, without the text when `packages_compact: true`); pipes in cells are escaped. `modootoday-check --twins` accepts that table around the byte-identical body. Pages without `packages:` are unchanged.
+
+## [1.4.0] - 2026-10-31
+
+### Added
+
+- `reference` layout: `packages_compact: true` leaves out the `text` under each package name, for pages whose body already describes the packages, and `packages_position: after` puts the package table below the body (default `before`). The include takes `compact=true` as well.
+
+### Fixed
+
+- `reference` layout: GitHub alerts (`> [!TIP]` and the rest), badges, `kbd:` and figures in the body are converted as in the `doc` layout; before, they stayed as plain quotes and `modootoday-check` reported unconverted alert markers.
+- Package table: the caption now sits inside the table border on wide screens (the border moved to a wrapper `div.mt-dx-pkgs`).
+- Docs: the package table include is for your own layouts and HTML pages; Markdown pages set `packages:` in front matter, since `modootoday-check` rejects Liquid in page bodies.
+
 ## [1.3.0] - 2026-10-31
 
 ### Added
@@ -275,7 +293,9 @@ Internal development milestones, never released. They are all part of 1.0.0.
 - Example: `sass.silence_deprecations: [import]` for Dart Sass; `llms.txt` per language generated instead of hand-written.
 - Raw `<name>.md` copies in `_site` on GitHub Pages: caused by content files without front matter (rendered by `jekyll-optional-front-matter` and also copied). Front matter is now required and checked.
 
-[Unreleased]: https://github.com/modootoday/jekyll-theme-modootoday/compare/v1.3.0...HEAD
+[Unreleased]: https://github.com/modootoday/jekyll-theme-modootoday/compare/v1.4.1...HEAD
+[1.4.1]: https://github.com/modootoday/jekyll-theme-modootoday/releases/tag/v1.4.1
+[1.4.0]: https://github.com/modootoday/jekyll-theme-modootoday/releases/tag/v1.4.0
 [1.3.0]: https://github.com/modootoday/jekyll-theme-modootoday/releases/tag/v1.3.0
 [1.2.3]: https://github.com/modootoday/jekyll-theme-modootoday/releases/tag/v1.2.3
 [1.2.2]: https://github.com/modootoday/jekyll-theme-modootoday/releases/tag/v1.2.2

data/README.ko.md

@@ -30,7 +30,7 @@ gem 방식(`theme:`):
 
 ```ruby
 # Gemfile
-gem "jekyll-theme-modootoday", "~> 1.3"
+gem "jekyll-theme-modootoday", "~> 1.4"
 ```
 
 ```yaml
@@ -42,7 +42,7 @@ Gemfile 없이 GitHub Pages에서(`remote_theme:`):
 
 ```yaml
 # _config.yml
-remote_theme: modootoday/jekyll-theme-modootoday@v1.3.0
+remote_theme: modootoday/jekyll-theme-modootoday@v1.4.1
 plugins:
   - jekyll-remote-theme
 ```
@@ -53,7 +53,7 @@ plugins:
 
 ```sh
 mkdir my-docs && cd my-docs
-printf 'source "https://rubygems.org"\ngem "jekyll", "~> 4.4"\ngem "jekyll-theme-modootoday", "~> 1.3"\n' > Gemfile
+printf 'source "https://rubygems.org"\ngem "jekyll", "~> 4.4"\ngem "jekyll-theme-modootoday", "~> 1.4"\n' > Gemfile
 printf 'theme: jekyll-theme-modootoday\nmarkdown: kramdown\nkramdown: {input: GFM}\nsass: {style: compressed, silence_deprecations: [import, global-builtin]}\n' > _config.yml
 printf -- '---\nlayout: doc\ntitle: Home\n---\n# Hello\n\n> [!TIP]\n> Plain Markdown, styled.\n' > index.md
 bundle install && bundle exec jekyll build

data/README.md

@@ -27,7 +27,7 @@ As a gem (`theme:`):
 
 ```ruby
 # Gemfile
-gem "jekyll-theme-modootoday", "~> 1.3"
+gem "jekyll-theme-modootoday", "~> 1.4"
 ```
 
 ```yaml
@@ -39,7 +39,7 @@ On GitHub Pages without a Gemfile (`remote_theme:`):
 
 ```yaml
 # _config.yml
-remote_theme: modootoday/jekyll-theme-modootoday@v1.3.0
+remote_theme: modootoday/jekyll-theme-modootoday@v1.4.1
 plugins:
   - jekyll-remote-theme
 ```
@@ -50,7 +50,7 @@ Pin a tag or a commit. More options: [Install guide](https://modootoday.github.i
 
 ```sh
 mkdir my-docs && cd my-docs
-printf 'source "https://rubygems.org"\ngem "jekyll", "~> 4.4"\ngem "jekyll-theme-modootoday", "~> 1.3"\n' > Gemfile
+printf 'source "https://rubygems.org"\ngem "jekyll", "~> 4.4"\ngem "jekyll-theme-modootoday", "~> 1.4"\n' > Gemfile
 printf 'theme: jekyll-theme-modootoday\nmarkdown: kramdown\nkramdown: {input: GFM}\nsass: {style: compressed, silence_deprecations: [import, global-builtin]}\n' > _config.yml
 printf -- '---\nlayout: doc\ntitle: Home\n---\n# Hello\n\n> [!TIP]\n> Plain Markdown, styled.\n' > index.md
 bundle install && bundle exec jekyll build

data/_includes/modootoday/docs-extra/packages.html

@@ -1,14 +1,15 @@
 {%- include modootoday/i18n.html -%}
-{%- comment -%}Package table: include.items is [{name, version, text, url, links: [{label, url}]}]; include.caption is optional.
-One row per package (the name is the row header, the text under it); rows stack into cards on narrow screens. CSS in docs-extra.{%- endcomment -%}
-<table class="mt-dx-pkgs">
+{%- comment -%}Package table: include.items is [{name, version, text, url, links: [{label, url}]}]; include.caption is optional;
+compact=true leaves out each package's text (for pages whose body already describes the packages).
+One row per package (the name is the row header, the text under it); rows stack into cards on narrow screens. CSS in docs-extra; the wrapper draws the border so the caption sits inside it.{%- endcomment -%}
+<div class="mt-dx-pkgs"><table>
 {%- if include.caption %}<caption>{{ include.caption }}</caption>{% endif %}
 <thead><tr><th scope="col">{{ mt_t_layouts_name }}</th><th scope="col">{{ mt_t_layouts_version }}</th><th scope="col">{{ mt_t_layouts_links }}</th></tr></thead>
 <tbody>
 {%- for p in include.items %}
-<tr id="{{ p.id | default: p.name | slugify }}"><th scope="row"><code>{% if p.url %}<a href="{% include modootoday/link.html url=p.url %}">{{ p.name }}</a>{% else %}{{ p.name }}{% endif %}</code>{% if p.text %}<span>{{ p.text | markdownify | remove: "<p>" | remove: "</p>" | strip }}</span>{% endif %}</th>
+<tr id="{{ p.id | default: p.name | slugify }}"><th scope="row"><code>{% if p.url %}<a href="{% include modootoday/link.html url=p.url %}">{{ p.name }}</a>{% else %}{{ p.name }}{% endif %}</code>{% if p.text and include.compact != true %}<span>{{ p.text | markdownify | remove: "<p>" | remove: "</p>" | strip }}</span>{% endif %}</th>
 <td data-label="{{ mt_t_layouts_version }}">{% if p.version %}<code>{{ p.version }}</code>{% endif %}</td>
 <td data-label="{{ mt_t_layouts_links }}">{% if p.links.size > 0 %}<ul>{% for l in p.links %}<li><a href="{% include modootoday/link.html url=l.url %}"{% include modootoday/links/attrs.html on=l.new_window target=l.target url=l.url %}>{{ l.label }}</a></li>{% endfor %}</ul>{% endif %}</td></tr>
 {%- endfor %}
 </tbody>
-</table>
+</table></div>

data/_includes/modootoday/markdown/packages.html

@@ -0,0 +1,22 @@
+{%- comment -%}md-components v1: the package table of include.page (reference layout, packages:) as Markdown, for the twin and
+llms-full layouts. Optional bold packages_title line, then | Name | Version | Links |; the name links to url, its text follows
+after ": " unless packages_compact; pipes are escaped and newlines become spaces. Ends with a newline. Empty without packages.{%- endcomment -%}
+{%- assign _pp = include.page -%}
+{%- if _pp.layout == "reference" and _pp.packages.size > 0 -%}
+{%- include modootoday/i18n.html -%}
+{%- assign _nl = "
+" -%}
+{%- if _pp.packages_title %}**{{ _pp.packages_title | replace: _nl, " " | replace: "|", "\|" }}**
+
+{% endif -%}
+| {{ mt_t_layouts_name }} | {{ mt_t_layouts_version }} | {{ mt_t_layouts_links }} |
+| --- | --- | --- |
+{% for p in _pp.packages -%}
+{%- capture _n %}`{{ p.name }}`{% endcapture -%}
+{%- if p.url %}{% capture _u %}{% include modootoday/link.html url=p.url %}{% endcapture %}{% assign _n = "[" | append: _n | append: "](" | append: _u | append: ")" %}{% endif -%}
+{%- if p.text and _pp.packages_compact != true %}{% assign _n = _n | append: ": " | append: p.text %}{% endif -%}
+{%- capture _ls %}{% for l in p.links %}{% unless forloop.first %}, {% endunless %}[{{ l.label }}]({% include modootoday/link.html url=l.url %}){% endfor %}{% endcapture -%}
+{%- capture _v %}{% if p.version %}`{{ p.version }}`{% endif %}{% endcapture -%}
+| {{ _n | replace: _nl, " " | replace: "|", "\|" }} | {{ _v | replace: "|", "\|" }} | {{ _ls | replace: _nl, " " | replace: "|", "\|" }} |
+{% endfor -%}
+{%- endif -%}

data/_includes/modootoday/markdown/raw-body.html

@@ -1,6 +1,14 @@
-{%- comment -%}md-components v1: the source body of include.file (path relative to the current page), front matter removed. Used by the twin and llms-full layouts.{%- endcomment -%}
+{%- comment -%}md-components v1: the source body of include.file (path relative to the current page), front matter removed. Used by the twin and llms-full layouts.
+With include.page (the source page), a reference page's packages: table is added before the body, or after it with packages_position: after.{%- endcomment -%}
 {%- capture _raw -%}{% include_relative {{ include.file }} %}{%- endcapture -%}
 {%- assign _fm = _raw | split: "---" -%}
 {%- assign _front = "---" | append: _fm[1] | append: "---
 " -%}
-{{- _raw | remove_first: _front -}}
+{%- assign _body = _raw | remove_first: _front -%}
+{%- capture _pkmd %}{% if include.page %}{% include modootoday/markdown/packages.html page=include.page %}{% endif %}{% endcapture -%}
+{%- if _pkmd == "" -%}{{- _body -}}
+{%- elsif include.page.packages_position == "after" -%}{{- _body }}
+{{ _pkmd -}}
+{%- else -%}{{- _pkmd }}
+{{ _body -}}
+{%- endif -%}

data/_layouts/llms-full.html

@@ -1,8 +1,8 @@
-{%- comment -%}md-components v1 llms-full.txt: the source body of every page of this language under this directory, byte-for-byte, separated by a blank line. Use from a stub: front matter `layout: llms-full` only.{%- endcomment -%}
+{%- comment -%}md-components v1 llms-full.txt: the source body of every page of this language under this directory, byte-for-byte (plus a reference page's packages: table as Markdown), separated by a blank line. Use from a stub: front matter `layout: llms-full` only.{%- endcomment -%}
 {%- include modootoday/markdown/llms-pages.html -%}
 {%- for _p in _llms_pages -%}
 {%- assign _rel = _p.path | remove_first: _llms_dir -%}
 {%- unless forloop.first %}
 {% endunless -%}
-{%- include modootoday/markdown/raw-body.html file=_rel -%}
+{%- include modootoday/markdown/raw-body.html file=_rel page=_p -%}
 {%- endfor -%}

data/_layouts/reference.html

@@ -6,7 +6,14 @@ mt_main: mt-dx mt-dx-reference
 {%- comment -%}reference: an API or option reference. members: [{name, signature, text, since, deprecated, id, group}] become a contents
 list and one section each (h2 with the name in code, the signature, the text, since / deprecated notes); the body comes first.
 Opt-in: sidebar: true puts the contents in a sticky side column (members grouped by group, in order of first use; CSS only, a plain
-list on narrow screens). packages: [{name, version, text, url, links: [{label, url}]}] adds a package table (packages.html) before the body.{%- endcomment -%}
+list on narrow screens). packages: [{name, version, text, url, links: [{label, url}]}] adds a package table (packages.html) before the body;
+packages_position: after puts it after the body, packages_compact: true leaves out each package's text. The body converts GitHub alerts,
+badges, kbd and figures like the doc layout (modootoday/markdown/components.html).{%- endcomment -%}
+{%- include modootoday/config.html -%}
+{%- assign _badges = mt_badges -%}{%- if page.badges == false -%}{%- assign _badges = false -%}{%- endif -%}{%- unless mt_components contains "badge" -%}{%- assign _badges = false -%}{%- endunless -%}
+{%- assign _fig = false -%}{%- if mt_components contains "figure" -%}{%- assign _fig = true -%}{%- endif -%}
+{%- assign _kbd = false -%}{%- if mt_components contains "kbd" -%}{%- assign _kbd = true -%}{%- endif -%}
+{%- capture _pkgs %}{% if page.packages %}{% include modootoday/docs-extra/packages.html items=page.packages caption=page.packages_title compact=page.packages_compact %}{% endif %}{% endcapture -%}
 <article aria-labelledby="mt-dx-title"{% if page.sidebar %} class="mt-dx-api"{% endif %}>
 {%- include modootoday/docs-extra/head.html %}
 {%- if page.sidebar and page.members.size > 0 %}
@@ -18,10 +25,11 @@ list on narrow screens). packages: [{name, version, text, url, links: [{label, u
 {%- elsif page.members.size > 1 %}
 <nav class="mt-dx-toc" aria-label="{{ mt_t_layouts_contents }}"><ul>{% for m in page.members %}<li><a href="#{{ m.id | default: m.name | slugify }}"><code>{{ m.name }}</code></a></li>{% endfor %}</ul></nav>
 {%- endif %}
-{%- if page.packages %}{% include modootoday/docs-extra/packages.html items=page.packages caption=page.packages_title %}{% endif %}
+{%- unless page.packages_position == "after" %}{{ _pkgs }}{% endunless %}
 <div class="mt-dx-body">
-{{ content }}
+{% include modootoday/markdown/components.html content=content lang=page.lang badges=_badges figure=_fig kbd=_kbd %}
 </div>
+{%- if page.packages_position == "after" %}{{ _pkgs }}{% endif %}
 {%- for m in page.members %}{% assign _id = m.id | default: m.name | slugify %}
 <section class="mt-dx-member" id="{{ _id }}" aria-labelledby="{{ _id }}-h">
 <h2 id="{{ _id }}-h"><code>{{ m.name }}</code></h2>

data/_layouts/twin.html

@@ -1,2 +1,5 @@
-{%- comment -%}md-components v1 twin: outputs the source body of page.twin_of byte-for-byte.{%- endcomment -%}
-{%- include modootoday/markdown/raw-body.html file=page.twin_of -%}
+{%- comment -%}md-components v1 twin: outputs the source body of page.twin_of byte-for-byte (a reference page's packages: table is added as Markdown).{%- endcomment -%}
+{%- assign _tdir = page.path | split: "/" | pop | join: "/" -%}{%- if _tdir != "" -%}{%- assign _tdir = _tdir | append: "/" -%}{%- endif -%}
+{%- assign _tpath = _tdir | append: page.twin_of -%}
+{%- assign _tpage = site.pages | where: "path", _tpath | first -%}
+{%- include modootoday/markdown/raw-body.html file=page.twin_of page=_tpage -%}

data/_sass/modootoday/docs-extra/_page.scss

@@ -48,8 +48,9 @@
     .mt-dx-api > .mt-dx-side { grid-column: 1; grid-row: 1 / span 999; align-self: start; position: sticky; top: 4.5rem; max-height: calc(100vh - 6rem); overflow-y: auto; padding-inline-end: .5rem; border-inline-end: 1px solid mt(border); }
     .mt-dx-api > .mt-dx-side ul { margin-bottom: 0; }
   }
-  .mt-dx-pkgs { display: table; width: 100%; margin-bottom: 2rem; }
-  .mt-dx-pkgs caption { padding: .75rem .9rem 0; font-weight: 600; text-align: start; }
+  .mt-dx-pkgs { overflow-x: auto; margin-bottom: 2rem; border: 1px solid mt(border); border-radius: mt(radius-lg); }
+  .mt-dx-pkgs table { display: table; width: 100%; margin: 0; border: 0; border-radius: 0; }
+  .mt-dx-pkgs caption { padding: .75rem .9rem .5rem; font-weight: 600; text-align: start; }
   .mt-dx-pkgs thead th { color: mt(muted-foreground); }
   .mt-dx-pkgs tbody th { white-space: normal; background: none; font-size: inherit; font-weight: 400; }
   .mt-dx-pkgs tr:last-child > th { border-bottom: 0; }
@@ -58,7 +59,7 @@
   .mt-dx-pkgs ul { display: flex; flex-wrap: wrap; gap: .25rem .75rem; margin: 0; padding: 0; list-style: none; }
   .mt-dx-pkgs li { margin: 0; }
   @media (max-width: 39.99rem) {
-    .mt-dx-pkgs, .mt-dx-pkgs caption, .mt-dx-pkgs tbody, .mt-dx-pkgs tr, .mt-dx-pkgs th, .mt-dx-pkgs td { display: block; }
+    .mt-dx-pkgs table, .mt-dx-pkgs caption, .mt-dx-pkgs tbody, .mt-dx-pkgs tr, .mt-dx-pkgs th, .mt-dx-pkgs td { display: block; }
     .mt-dx-pkgs thead { position: absolute; width: 1px; height: 1px; overflow: hidden; clip-path: inset(50%); }
     .mt-dx-pkgs tr { padding: .5rem .9rem; border-bottom: 1px solid mt(border); }
     .mt-dx-pkgs tr:last-child { border-bottom: 0; }

data/lib/modootoday/check/layouts/docs_extra.rb

@@ -17,10 +17,11 @@ module Modootoday
           send(fm["layout"], errs, w, fm)
         end
 
-        # members is required unless the page lists packages; sidebar: is true or false; packages need a name, links a label and url.
+        # members is required unless the page lists packages; sidebar: and packages_compact: are true or false, packages_position: before or after; packages need a name, links a label and url.
         def reference(errs, w, fm)
           Shape.list(errs, w, "members", fm["members"], any: %w[name], optional: fm.key?("packages"))
-          errs << "#{w}: sidebar must be true or false" unless [nil, true, false].include?(fm["sidebar"])
+          %w[sidebar packages_compact].each { |k| errs << "#{w}: #{k} must be true or false" unless [nil, true, false].include?(fm[k]) }
+          Shape.one_of(errs, w, "packages_position", fm["packages_position"], %w[before after]) if fm.key?("packages_position")
           Shape.list(errs, w, "packages", fm["packages"], any: %w[name]) do |p, i|
             Shape.list(errs, w, "packages[#{i}].links", p["links"], any: %w[label]) do |l, j|
               errs << "#{w}: packages[#{i}].links[#{j}].url is required" unless Shape.url?(l["url"])

data/lib/modootoday/check/twins.rb

@@ -6,6 +6,8 @@ module Modootoday
     #    (/index.md for index.md), byte-identical to its source body. It comes from a stub <name>.md.txt
     #    (layout: twin; works on GitHub Pages) or from the opt-in plugin (plugins: [jekyll-theme-modootoday]).
     #    With modootoday.twins: source, a page without front matter is its own twin at /<path>.md.
+    #    A reference page's packages: table is added to its twin as Markdown, before the body (or after it with
+    #    packages_position: after); the body itself must still be there byte-for-byte.
     #    llms.txt / llms-full.txt exist at / and at each /<lang>/; llms-full.txt contains every page body.
     module Twins
       HINT = "add a stub %s (front matter `layout: twin`, `twin_of`, `permalink`) or enable `plugins: [jekyll-theme-modootoday]` (not on classic GitHub Pages)"
@@ -43,10 +45,20 @@ module Modootoday
           return
         end
         out = File.basename(r) == "index" ? "#{site}/#{r}.md" : "#{site}/#{r}/index.md"
-        b = Markdown.body(File.read(f))
+        src = File.read(f)
+        b = Markdown.body(src)
         bodies[ctx.lang_of(r).to_s] << [rf, b]
         return errs << "#{rf}: twin missing at #{out}: #{format(HINT, "#{rf}.txt")}" unless File.exist?(out)
-        errs << "#{out}: twin is not byte-identical to the body of #{rf}" unless File.binread(out) == b.b
+        tw = File.binread(out)
+        fm = (Markdown.fm(src) rescue {})
+        pk = fm["layout"] == "reference" && fm["packages"].is_a?(Array) && !fm["packages"].empty? ? fm["packages"] : nil
+        return errs << "#{out}: twin is not byte-identical to the body of #{rf}" unless pk || tw == b.b
+        return unless pk
+        after = fm["packages_position"] == "after"
+        ok = after ? tw.start_with?(b.b) : tw.end_with?(b.b)
+        names = pk.map { |x| x.is_a?(Hash) ? x["name"].to_s : "" }
+        ok &&= names.all? { |n| tw.include?("`#{n}`".b) }
+        errs << "#{out}: twin must be the body of #{rf} with its packages: table #{after ? 'after' : 'before'} it" unless ok
       end
 
       def llms(ctx, bodies)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-modootoday
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - modootoday
@@ -134,6 +134,7 @@ files:
 - _includes/modootoday/markdown/inline.html
 - _includes/modootoday/markdown/lists.html
 - _includes/modootoday/markdown/llms-pages.html
+- _includes/modootoday/markdown/packages.html
 - _includes/modootoday/markdown/raw-body.html
 - _includes/modootoday/markdown/sections.html
 - _includes/modootoday/markdown/split.html