jekyll-theme-modootoday 1.3.0 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -1
- data/README.ko.md +3 -3
- data/README.md +3 -3
- data/_includes/modootoday/docs-extra/packages.html +6 -5
- data/_layouts/reference.html +11 -3
- data/_sass/modootoday/docs-extra/_page.scss +4 -3
- data/lib/modootoday/check/layouts/docs_extra.rb +3 -2
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 56331c6dac359c696c167df9919dc66dbe9616362e056b597aa95c57ca11bcb2
|
|
4
|
+
data.tar.gz: ec6fca55ae534ff1326c889fbbdb4f477aed4c759b99b26659012b738a4d06c3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: afe53d2405f415fa08cb9f590512b804e9ca4c7128ef7005d0a1f0d128784fd84ef7db7a7350d59475e45799d218443c0aa10384a6a6e95c80f570e16b859ea4
|
|
7
|
+
data.tar.gz: 0c2fee882f3647b394dd5bcf2c17683880b2336862d868c6ff194a7ce8e172786c0b0b0101b54f91271b4e9af61876a88983ff11290649f00686034b816a1235
|
data/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,18 @@ The content rules have their own version header (`md-components v1`) in [RULES.m
|
|
|
6
6
|
|
|
7
7
|
## [Unreleased]
|
|
8
8
|
|
|
9
|
+
## [1.4.0] - 2026-10-31
|
|
10
|
+
|
|
11
|
+
### Added
|
|
12
|
+
|
|
13
|
+
- `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.
|
|
14
|
+
|
|
15
|
+
### Fixed
|
|
16
|
+
|
|
17
|
+
- `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.
|
|
18
|
+
- Package table: the caption now sits inside the table border on wide screens (the border moved to a wrapper `div.mt-dx-pkgs`).
|
|
19
|
+
- 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.
|
|
20
|
+
|
|
9
21
|
## [1.3.0] - 2026-10-31
|
|
10
22
|
|
|
11
23
|
### Added
|
|
@@ -275,7 +287,8 @@ Internal development milestones, never released. They are all part of 1.0.0.
|
|
|
275
287
|
- Example: `sass.silence_deprecations: [import]` for Dart Sass; `llms.txt` per language generated instead of hand-written.
|
|
276
288
|
- 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.
|
|
277
289
|
|
|
278
|
-
[Unreleased]: https://github.com/modootoday/jekyll-theme-modootoday/compare/v1.
|
|
290
|
+
[Unreleased]: https://github.com/modootoday/jekyll-theme-modootoday/compare/v1.4.0...HEAD
|
|
291
|
+
[1.4.0]: https://github.com/modootoday/jekyll-theme-modootoday/releases/tag/v1.4.0
|
|
279
292
|
[1.3.0]: https://github.com/modootoday/jekyll-theme-modootoday/releases/tag/v1.3.0
|
|
280
293
|
[1.2.3]: https://github.com/modootoday/jekyll-theme-modootoday/releases/tag/v1.2.3
|
|
281
294
|
[1.2.2]: https://github.com/modootoday/jekyll-theme-modootoday/releases/tag/v1.2.2
|
data/README.ko.md
CHANGED
|
@@ -30,7 +30,7 @@ gem 방식(`theme:`):
|
|
|
30
30
|
|
|
31
31
|
```ruby
|
|
32
32
|
# Gemfile
|
|
33
|
-
gem "jekyll-theme-modootoday", "~> 1.
|
|
33
|
+
gem "jekyll-theme-modootoday", "~> 1.4"
|
|
34
34
|
```
|
|
35
35
|
|
|
36
36
|
```yaml
|
|
@@ -42,7 +42,7 @@ Gemfile 없이 GitHub Pages에서(`remote_theme:`):
|
|
|
42
42
|
|
|
43
43
|
```yaml
|
|
44
44
|
# _config.yml
|
|
45
|
-
remote_theme: modootoday/jekyll-theme-modootoday@v1.
|
|
45
|
+
remote_theme: modootoday/jekyll-theme-modootoday@v1.4.0
|
|
46
46
|
plugins:
|
|
47
47
|
- jekyll-remote-theme
|
|
48
48
|
```
|
|
@@ -53,7 +53,7 @@ plugins:
|
|
|
53
53
|
|
|
54
54
|
```sh
|
|
55
55
|
mkdir my-docs && cd my-docs
|
|
56
|
-
printf 'source "https://rubygems.org"\ngem "jekyll", "~> 4.4"\ngem "jekyll-theme-modootoday", "~> 1.
|
|
56
|
+
printf 'source "https://rubygems.org"\ngem "jekyll", "~> 4.4"\ngem "jekyll-theme-modootoday", "~> 1.4"\n' > Gemfile
|
|
57
57
|
printf 'theme: jekyll-theme-modootoday\nmarkdown: kramdown\nkramdown: {input: GFM}\nsass: {style: compressed, silence_deprecations: [import, global-builtin]}\n' > _config.yml
|
|
58
58
|
printf -- '---\nlayout: doc\ntitle: Home\n---\n# Hello\n\n> [!TIP]\n> Plain Markdown, styled.\n' > index.md
|
|
59
59
|
bundle install && bundle exec jekyll build
|
data/README.md
CHANGED
|
@@ -27,7 +27,7 @@ As a gem (`theme:`):
|
|
|
27
27
|
|
|
28
28
|
```ruby
|
|
29
29
|
# Gemfile
|
|
30
|
-
gem "jekyll-theme-modootoday", "~> 1.
|
|
30
|
+
gem "jekyll-theme-modootoday", "~> 1.4"
|
|
31
31
|
```
|
|
32
32
|
|
|
33
33
|
```yaml
|
|
@@ -39,7 +39,7 @@ On GitHub Pages without a Gemfile (`remote_theme:`):
|
|
|
39
39
|
|
|
40
40
|
```yaml
|
|
41
41
|
# _config.yml
|
|
42
|
-
remote_theme: modootoday/jekyll-theme-modootoday@v1.
|
|
42
|
+
remote_theme: modootoday/jekyll-theme-modootoday@v1.4.0
|
|
43
43
|
plugins:
|
|
44
44
|
- jekyll-remote-theme
|
|
45
45
|
```
|
|
@@ -50,7 +50,7 @@ Pin a tag or a commit. More options: [Install guide](https://modootoday.github.i
|
|
|
50
50
|
|
|
51
51
|
```sh
|
|
52
52
|
mkdir my-docs && cd my-docs
|
|
53
|
-
printf 'source "https://rubygems.org"\ngem "jekyll", "~> 4.4"\ngem "jekyll-theme-modootoday", "~> 1.
|
|
53
|
+
printf 'source "https://rubygems.org"\ngem "jekyll", "~> 4.4"\ngem "jekyll-theme-modootoday", "~> 1.4"\n' > Gemfile
|
|
54
54
|
printf 'theme: jekyll-theme-modootoday\nmarkdown: kramdown\nkramdown: {input: GFM}\nsass: {style: compressed, silence_deprecations: [import, global-builtin]}\n' > _config.yml
|
|
55
55
|
printf -- '---\nlayout: doc\ntitle: Home\n---\n# Hello\n\n> [!TIP]\n> Plain Markdown, styled.\n' > index.md
|
|
56
56
|
bundle install && bundle exec jekyll build
|
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
{%- include modootoday/i18n.html -%}
|
|
2
|
-
{%- comment -%}Package table: include.items is [{name, version, text, url, links: [{label, url}]}]; include.caption is optional
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
{%- comment -%}Package table: include.items is [{name, version, text, url, links: [{label, url}]}]; include.caption is optional;
|
|
3
|
+
compact=true leaves out each package's text (for pages whose body already describes the packages).
|
|
4
|
+
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 -%}
|
|
5
|
+
<div class="mt-dx-pkgs"><table>
|
|
5
6
|
{%- if include.caption %}<caption>{{ include.caption }}</caption>{% endif %}
|
|
6
7
|
<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>
|
|
7
8
|
<tbody>
|
|
8
9
|
{%- for p in include.items %}
|
|
9
|
-
<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>
|
|
10
|
+
<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>
|
|
10
11
|
<td data-label="{{ mt_t_layouts_version }}">{% if p.version %}<code>{{ p.version }}</code>{% endif %}</td>
|
|
11
12
|
<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>
|
|
12
13
|
{%- endfor %}
|
|
13
14
|
</tbody>
|
|
14
|
-
</table>
|
|
15
|
+
</table></div>
|
data/_layouts/reference.html
CHANGED
|
@@ -6,7 +6,14 @@ mt_main: mt-dx mt-dx-reference
|
|
|
6
6
|
{%- comment -%}reference: an API or option reference. members: [{name, signature, text, since, deprecated, id, group}] become a contents
|
|
7
7
|
list and one section each (h2 with the name in code, the signature, the text, since / deprecated notes); the body comes first.
|
|
8
8
|
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
|
|
9
|
-
list on narrow screens). packages: [{name, version, text, url, links: [{label, url}]}] adds a package table (packages.html) before the body
|
|
9
|
+
list on narrow screens). packages: [{name, version, text, url, links: [{label, url}]}] adds a package table (packages.html) before the body;
|
|
10
|
+
packages_position: after puts it after the body, packages_compact: true leaves out each package's text. The body converts GitHub alerts,
|
|
11
|
+
badges, kbd and figures like the doc layout (modootoday/markdown/components.html).{%- endcomment -%}
|
|
12
|
+
{%- include modootoday/config.html -%}
|
|
13
|
+
{%- assign _badges = mt_badges -%}{%- if page.badges == false -%}{%- assign _badges = false -%}{%- endif -%}{%- unless mt_components contains "badge" -%}{%- assign _badges = false -%}{%- endunless -%}
|
|
14
|
+
{%- assign _fig = false -%}{%- if mt_components contains "figure" -%}{%- assign _fig = true -%}{%- endif -%}
|
|
15
|
+
{%- assign _kbd = false -%}{%- if mt_components contains "kbd" -%}{%- assign _kbd = true -%}{%- endif -%}
|
|
16
|
+
{%- capture _pkgs %}{% if page.packages %}{% include modootoday/docs-extra/packages.html items=page.packages caption=page.packages_title compact=page.packages_compact %}{% endif %}{% endcapture -%}
|
|
10
17
|
<article aria-labelledby="mt-dx-title"{% if page.sidebar %} class="mt-dx-api"{% endif %}>
|
|
11
18
|
{%- include modootoday/docs-extra/head.html %}
|
|
12
19
|
{%- if page.sidebar and page.members.size > 0 %}
|
|
@@ -18,10 +25,11 @@ list on narrow screens). packages: [{name, version, text, url, links: [{label, u
|
|
|
18
25
|
{%- elsif page.members.size > 1 %}
|
|
19
26
|
<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>
|
|
20
27
|
{%- endif %}
|
|
21
|
-
{%-
|
|
28
|
+
{%- unless page.packages_position == "after" %}{{ _pkgs }}{% endunless %}
|
|
22
29
|
<div class="mt-dx-body">
|
|
23
|
-
{
|
|
30
|
+
{% include modootoday/markdown/components.html content=content lang=page.lang badges=_badges figure=_fig kbd=_kbd %}
|
|
24
31
|
</div>
|
|
32
|
+
{%- if page.packages_position == "after" %}{{ _pkgs }}{% endif %}
|
|
25
33
|
{%- for m in page.members %}{% assign _id = m.id | default: m.name | slugify %}
|
|
26
34
|
<section class="mt-dx-member" id="{{ _id }}" aria-labelledby="{{ _id }}-h">
|
|
27
35
|
<h2 id="{{ _id }}-h"><code>{{ m.name }}</code></h2>
|
|
@@ -48,8 +48,9 @@
|
|
|
48
48
|
.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); }
|
|
49
49
|
.mt-dx-api > .mt-dx-side ul { margin-bottom: 0; }
|
|
50
50
|
}
|
|
51
|
-
.mt-dx-pkgs {
|
|
52
|
-
.mt-dx-pkgs
|
|
51
|
+
.mt-dx-pkgs { overflow-x: auto; margin-bottom: 2rem; border: 1px solid mt(border); border-radius: mt(radius-lg); }
|
|
52
|
+
.mt-dx-pkgs table { display: table; width: 100%; margin: 0; border: 0; border-radius: 0; }
|
|
53
|
+
.mt-dx-pkgs caption { padding: .75rem .9rem .5rem; font-weight: 600; text-align: start; }
|
|
53
54
|
.mt-dx-pkgs thead th { color: mt(muted-foreground); }
|
|
54
55
|
.mt-dx-pkgs tbody th { white-space: normal; background: none; font-size: inherit; font-weight: 400; }
|
|
55
56
|
.mt-dx-pkgs tr:last-child > th { border-bottom: 0; }
|
|
@@ -58,7 +59,7 @@
|
|
|
58
59
|
.mt-dx-pkgs ul { display: flex; flex-wrap: wrap; gap: .25rem .75rem; margin: 0; padding: 0; list-style: none; }
|
|
59
60
|
.mt-dx-pkgs li { margin: 0; }
|
|
60
61
|
@media (max-width: 39.99rem) {
|
|
61
|
-
.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; }
|
|
62
|
+
.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; }
|
|
62
63
|
.mt-dx-pkgs thead { position: absolute; width: 1px; height: 1px; overflow: hidden; clip-path: inset(50%); }
|
|
63
64
|
.mt-dx-pkgs tr { padding: .5rem .9rem; border-bottom: 1px solid mt(border); }
|
|
64
65
|
.mt-dx-pkgs tr:last-child { border-bottom: 0; }
|
|
@@ -17,10 +17,11 @@ module Modootoday
|
|
|
17
17
|
send(fm["layout"], errs, w, fm)
|
|
18
18
|
end
|
|
19
19
|
|
|
20
|
-
# members is required unless the page lists packages; sidebar:
|
|
20
|
+
# 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.
|
|
21
21
|
def reference(errs, w, fm)
|
|
22
22
|
Shape.list(errs, w, "members", fm["members"], any: %w[name], optional: fm.key?("packages"))
|
|
23
|
-
errs << "#{w}:
|
|
23
|
+
%w[sidebar packages_compact].each { |k| errs << "#{w}: #{k} must be true or false" unless [nil, true, false].include?(fm[k]) }
|
|
24
|
+
Shape.one_of(errs, w, "packages_position", fm["packages_position"], %w[before after]) if fm.key?("packages_position")
|
|
24
25
|
Shape.list(errs, w, "packages", fm["packages"], any: %w[name]) do |p, i|
|
|
25
26
|
Shape.list(errs, w, "packages[#{i}].links", p["links"], any: %w[label]) do |l, j|
|
|
26
27
|
errs << "#{w}: packages[#{i}].links[#{j}].url is required" unless Shape.url?(l["url"])
|