jekyll-theme-modootoday 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2267c53131e210e3f7f99a1996f043db0b5705671cfa02010c4f9434c5353bb7
-  data.tar.gz: f22bf89f56a0098b382d13056e993252a15f86dcde7064935b320ba2a5f60ea4
+  metadata.gz: 9eb1c4e782cdbaba12079575f273b74a14e9a0e701139858cbf72bf665409d2d
+  data.tar.gz: 41b86c06c720c2ca4077aed45c2e1cf8457aa2774630ffc3e28c8e8aa1041afa
 SHA512:
-  metadata.gz: ed8043a8dcf73c34e666104c037f287936d8ad6be73202d31eb699c5aff2a7a08059a6e760e419049716c8fc64a1e229f8ab1ac1683748ce0e4168a28bc4e8ac
-  data.tar.gz: b50e62f0b1ca1c0d206b1020704b1de403ad599e53cf52e18a25c3ad94451768546273e6305d129200f47a85781c23559cd7a70670ae427eedda175bbcbacd4f
+  metadata.gz: fd67889b39a19ad4d5e462543d8eb237d8e5823a2713aeeb9d7189d72ab71bbaf252f83e97a406edfb75ba760b822d9137bd211d8670f8cd47264d39a9c6d197
+  data.tar.gz: b7185e039610c3d5641eb29bf34a91bc436bdf3113645dd4ed07036e5d2d55d388bb1ffc74ea932d2ad0c88e70235ac2c123f45a002f902f5da2b3abde263dcf

data/CHANGELOG.md

@@ -6,6 +6,15 @@ The content rules have their own version header (`md-components v1`) in [RULES.m
 
 ## [Unreleased]
 
+## [1.3.0] - 2026-10-31
+
+### Added
+
+- `reference` layout, opt-in API sidebar: `sidebar: true` puts the member list in a side column that stays in view from 64rem up, with members grouped under their `group:` label (in order of first use); narrower screens show the same list above the page. CSS only, in the docs-extra bundle.
+- `reference` layout, opt-in package table: `packages: [{name, version, text, url, links: [{label, url}]}]` (and an optional `packages_title:` caption) lists packages or crates with name, version, description and links before the body; rows stack into cards on small screens. The table is also available as `{% include modootoday/docs-extra/packages.html items=… %}`. A page with `packages:` may leave out `members:`.
+- `modootoday-check` reports a `sidebar:` that is not true or false, a package with no `name`, and a package link with no `url`.
+- API reference demo (en, ko, ja) and docs for both parts; the docs audit covers the new demo page.
+
 ## [1.2.3] - 2026-10-31
 
 ### Changed
@@ -266,7 +275,8 @@ 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.2.3...HEAD
+[Unreleased]: https://github.com/modootoday/jekyll-theme-modootoday/compare/v1.3.0...HEAD
+[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
 [1.2.1]: https://github.com/modootoday/jekyll-theme-modootoday/releases/tag/v1.2.1

data/README.ko.md

@@ -30,7 +30,7 @@ gem 방식(`theme:`):
 
 ```ruby
 # Gemfile
-gem "jekyll-theme-modootoday", "~> 1.2"
+gem "jekyll-theme-modootoday", "~> 1.3"
 ```
 
 ```yaml
@@ -42,7 +42,7 @@ Gemfile 없이 GitHub Pages에서(`remote_theme:`):
 
 ```yaml
 # _config.yml
-remote_theme: modootoday/jekyll-theme-modootoday@v1.2.3
+remote_theme: modootoday/jekyll-theme-modootoday@v1.3.0
 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.2"\n' > Gemfile
+printf 'source "https://rubygems.org"\ngem "jekyll", "~> 4.4"\ngem "jekyll-theme-modootoday", "~> 1.3"\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.2"
+gem "jekyll-theme-modootoday", "~> 1.3"
 ```
 
 ```yaml
@@ -39,7 +39,7 @@ On GitHub Pages without a Gemfile (`remote_theme:`):
 
 ```yaml
 # _config.yml
-remote_theme: modootoday/jekyll-theme-modootoday@v1.2.3
+remote_theme: modootoday/jekyll-theme-modootoday@v1.3.0
 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.2"\n' > Gemfile
+printf 'source "https://rubygems.org"\ngem "jekyll", "~> 4.4"\ngem "jekyll-theme-modootoday", "~> 1.3"\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

@@ -0,0 +1,14 @@
+{%- 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">
+{%- 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>
+<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>

data/_layouts/reference.html

@@ -3,13 +3,22 @@ layout: default
 mt_bundle: docs-extra
 mt_main: mt-dx mt-dx-reference
 ---
-{%- comment -%}reference: an API or option reference. members: [{name, signature, text, since, deprecated, id}] 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.{%- endcomment -%}
-<article aria-labelledby="mt-dx-title">
+{%- 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 -%}
+<article aria-labelledby="mt-dx-title"{% if page.sidebar %} class="mt-dx-api"{% endif %}>
 {%- include modootoday/docs-extra/head.html %}
-{%- if page.members.size > 1 %}
+{%- if page.sidebar and page.members.size > 0 %}
+<nav class="mt-dx-side" aria-label="{{ mt_t_layouts_contents }}"><ul>
+{%- assign _groups = page.members | group_by: "group" %}{% for g in _groups %}
+{%- capture _links %}{% for m in g.items %}<li><a href="#{{ m.id | default: m.name | slugify }}"><code>{{ m.name }}</code></a></li>{% endfor %}{% endcapture %}
+{%- if g.name != "" %}<li><span class="mt-dx-side-h">{{ g.name }}</span><ul>{{ _links }}</ul></li>{% else %}{{ _links }}{% endif %}
+{%- endfor %}</ul></nav>
+{%- 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 %}
 <div class="mt-dx-body">
 {{ content }}
 </div>

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

@@ -35,3 +35,36 @@
   .mt-dx-chapters li { padding: .5rem 0; border-bottom: 1px solid mt(border); }
   @media print { .mt-dx-toc, .mt-dx-letters { display: none; } .mt-dx-col, .mt-dx-member, .mt-dx-release { break-inside: avoid; } }
 }
+// Opt-in reference parts: the API sidebar (sidebar: true) and the package table (packages:).
+@include mt-layer(components) {
+  .mt-dx-side ul { margin: 0 0 1.5rem; padding: 0; list-style: none; }
+  .mt-dx-side ul ul { margin: .25rem 0 .75rem; }
+  .mt-dx-side a { display: block; padding: .25rem .5rem; border-radius: mt(radius); text-decoration: none; }
+  .mt-dx-side a:hover { background: mt(muted); }
+  .mt-dx-side-h { display: block; padding: .5rem .5rem .25rem; font-size: .8125rem; font-weight: 600; color: mt(muted-foreground); }
+  @media (min-width: 64rem) {
+    .mt-dx-api { display: grid; grid-template-columns: 14rem minmax(0, 1fr); column-gap: 2.5rem; }
+    .mt-dx-api > * { grid-column: 2; }
+    .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 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; }
+  .mt-dx-pkgs tbody th > code { font-weight: 600; }
+  .mt-dx-pkgs tbody th > span { display: block; margin-top: .25rem; color: mt(muted-foreground); }
+  .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 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; }
+    .mt-dx-pkgs tbody th, .mt-dx-pkgs td { padding: .25rem 0; border: 0; }
+    .mt-dx-pkgs td:empty { display: none; }
+    .mt-dx-pkgs td::before { content: attr(data-label) ": "; color: mt(muted-foreground); font-size: .8125rem; }
+  }
+  @media print { .mt-dx-side { display: none; } .mt-dx-api { display: block; } }
+}

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

@@ -17,7 +17,16 @@ module Modootoday
           send(fm["layout"], errs, w, fm)
         end
 
-        def reference(errs, w, fm) = Shape.list(errs, w, "members", fm["members"], any: %w[name], optional: false)
+        # members is required unless the page lists packages; sidebar: is true or false; 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"])
+          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"])
+            end
+          end
+        end
 
         def changelog(errs, w, fm)
           Shape.list(errs, w, "releases", fm["releases"], any: %w[version], optional: false) do |r, i|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-modootoday
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - modootoday
@@ -79,6 +79,7 @@ files:
 - _includes/modootoday/doc/twin.html
 - _includes/modootoday/docs-extra/head.html
 - _includes/modootoday/docs-extra/jsonld.html
+- _includes/modootoday/docs-extra/packages.html
 - _includes/modootoday/head-meta.html
 - _includes/modootoday/home-url.html
 - _includes/modootoday/i18n.html