jekyll-documents 0.7.8 → 0.7.9
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 +43 -1
- data/README.md +34 -2
- data/interface.yml +1 -1
- data/jekyll-documents.gemspec +17 -4
- data/lib/jekyll/documents/version.rb +1 -1
- metadata +14 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7094710c4d74d360ac4987438735419161a107b58f2d6d0e4c5900c63e8bf6ee
|
|
4
|
+
data.tar.gz: c703917eac0b4bf10862b42245f7d4f282142d698d7bbe25f4bb478c5a2ec0e4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 64abcdf3a27647e1728df5c67b76c7527996f7d7fd410fee097af938cf996c35ef1993a2e5ea97836acc43bb57256ba8867e7846613c30635536347c43541c53
|
|
7
|
+
data.tar.gz: 78a60738b1d50cc2473e67f52bb3ee4016aa8a56e4a789d57fd33af43d893def3365f0c7926c69c903af722e6e1a6ebfbad4f9b211be341e9c8535ceebc02ba0
|
data/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,46 @@
|
|
|
2
2
|
|
|
3
3
|
## [Unreleased]
|
|
4
4
|
|
|
5
|
+
## [0.7.9] - 2026-11-10
|
|
6
|
+
|
|
7
|
+
### Added
|
|
8
|
+
|
|
9
|
+
- `rake docs:demo` — captures the checked-in illustrative overview as
|
|
10
|
+
animated AVIF + WebP + static PNG (headless Chrome + ffmpeg + img2webp;
|
|
11
|
+
build-host tools), embedded in README via `<picture>`. Examples are
|
|
12
|
+
schematic, not generated from a live Jekyll build.
|
|
13
|
+
|
|
14
|
+
### Changed
|
|
15
|
+
|
|
16
|
+
- Gemspec `description` now renders as RDoc on rubygems.org — the heredoc
|
|
17
|
+
opens with an `==`-level heading at column 0 so the gem page shows
|
|
18
|
+
headings and bullet lists instead of one plain paragraph — and mentions
|
|
19
|
+
the jekyll-imgflow-vscode VS Code companion extension for tag
|
|
20
|
+
autocomplete.
|
|
21
|
+
- Dev-tooling bumps: `markdownlint-cli2` 0.24.0, `rubocop` 1.92.2,
|
|
22
|
+
`@playwright/test` 1.65.0; transitive bumps addressable 2.9.2,
|
|
23
|
+
csv 3.3.7, parser 3.3.13.0, sass-embedded 1.108.1, nokogiri 1.19.7,
|
|
24
|
+
activesupport 8.1.4.1, minitest 6.1.0, irb 1.19.0;
|
|
25
|
+
`BUNDLED WITH` 4.0.6 → 4.0.24.
|
|
26
|
+
- CI: `ruby/setup-ruby` pin bumped v1.335.0 → v1.338.0.
|
|
27
|
+
- CI: Semgrep runs as a pinned `semgrep/semgrep` container image
|
|
28
|
+
(tag + sha256 digest), bumped to 1.183.0. Dependabot cannot update
|
|
29
|
+
`jobs.<id>.container.image` refs (dependabot/dependabot-core#5819), so
|
|
30
|
+
`dependabot.yml` documents the pin as a manual bump.
|
|
31
|
+
- CI: `SonarSource/sonarqube-scan-action` v8.3.0 → v8.4.0 (SHA pin).
|
|
32
|
+
- Spec cleanup: renamed the inverted "does not duplicate documents"
|
|
33
|
+
generator example (it asserted documents ARE appended on a second
|
|
34
|
+
`generate` run) and trimmed the `latest_documents` integration spec to
|
|
35
|
+
the unique `Liquid::Template.parse` path it actually covers
|
|
36
|
+
(319 examples).
|
|
37
|
+
|
|
38
|
+
### Security
|
|
39
|
+
|
|
40
|
+
- `markdownlint-cli2` 0.24.0 pulls in `markdownlint` → `re2js` 2.8.6,
|
|
41
|
+
affected by GHSA-gg6h-894w-4m9c (quadratic-time DoS in lookbehind
|
|
42
|
+
matching). Forced patched `re2js` ~2.8.7 (resolves to 2.8.8) via
|
|
43
|
+
`overrides` — no allowlist entry needed.
|
|
44
|
+
|
|
5
45
|
## [0.7.8] - 2026-10-13
|
|
6
46
|
|
|
7
47
|
### Changed
|
|
@@ -20,7 +60,9 @@
|
|
|
20
60
|
|
|
21
61
|
- `rake version:bump` now actually syncs `example/Gemfile.lock` — under
|
|
22
62
|
`bundle exec`, `BUNDLE_GEMFILE` pinned the root Gemfile, so the `bundle
|
|
23
|
-
lock` in `example/` silently rewrote the root lockfile instead
|
|
63
|
+
lock` in `example/` silently rewrote the root lockfile instead — and
|
|
64
|
+
regenerates `interface.yml`, which embeds the gem version and otherwise
|
|
65
|
+
leaves `interface_spec` failing after every bump.
|
|
24
66
|
|
|
25
67
|
## [0.7.7] - 2026-10-06
|
|
26
68
|
|
data/README.md
CHANGED
|
@@ -17,7 +17,18 @@ Turn files in `assets/documents/` into browsable document pages.
|
|
|
17
17
|
|
|
18
18
|
**Features**: Auto-collection • File icons • Categories • Search
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
<!-- markdownlint-disable MD033 -->
|
|
21
|
+
<picture>
|
|
22
|
+
<source
|
|
23
|
+
srcset="docs/assets/jekyll-documents-demo.avif"
|
|
24
|
+
type="image/avif">
|
|
25
|
+
<source
|
|
26
|
+
srcset="docs/assets/jekyll-documents-demo.webp"
|
|
27
|
+
type="image/webp">
|
|
28
|
+
<img src="docs/assets/jekyll-documents-demo.png"
|
|
29
|
+
alt="jekyll-documents demo">
|
|
30
|
+
</picture>
|
|
31
|
+
<!-- markdownlint-enable MD033 -->
|
|
21
32
|
|
|
22
33
|
## Quick Start
|
|
23
34
|
|
|
@@ -373,6 +384,27 @@ On macOS and other non-standard installations, the executable is discovered
|
|
|
373
384
|
from `PATH`. You can also configure a custom `pdftotext` command through the
|
|
374
385
|
`plaintext` gem configuration.
|
|
375
386
|
|
|
387
|
+
## VS Code extension
|
|
388
|
+
|
|
389
|
+
[jekyll-imgflow-vscode](https://github.com/gundestrup/jekyll-imgflow-vscode)
|
|
390
|
+
autocompletes `{% doc_link %}`, `{% doc_category %}`, `{% document_icon %}`
|
|
391
|
+
and `{% latest_documents %}` in VS Code / VSCodium — document titles and
|
|
392
|
+
categories, tag parameters, and exact `path:` values to disambiguate
|
|
393
|
+
duplicate titles:
|
|
394
|
+
|
|
395
|
+
<!-- markdownlint-disable MD033 -->
|
|
396
|
+
<picture>
|
|
397
|
+
<source
|
|
398
|
+
srcset="https://raw.githubusercontent.com/gundestrup/jekyll-imgflow-vscode/main/docs/assets/document-flow.avif"
|
|
399
|
+
type="image/avif">
|
|
400
|
+
<source
|
|
401
|
+
srcset="https://raw.githubusercontent.com/gundestrup/jekyll-imgflow-vscode/main/docs/assets/document-flow.webp"
|
|
402
|
+
type="image/webp">
|
|
403
|
+
<img src="https://raw.githubusercontent.com/gundestrup/jekyll-imgflow-vscode/main/docs/assets/document-flow.png"
|
|
404
|
+
alt="jekyll-imgflow-vscode: document title, parameter and path: autocomplete">
|
|
405
|
+
</picture>
|
|
406
|
+
<!-- markdownlint-enable MD033 -->
|
|
407
|
+
|
|
376
408
|
## Development
|
|
377
409
|
|
|
378
410
|
```bash
|
|
@@ -383,7 +415,7 @@ rake quick # Fast check (style + markdown + tests)
|
|
|
383
415
|
rake help # Show commands
|
|
384
416
|
```
|
|
385
417
|
|
|
386
|
-
**Quality**:
|
|
418
|
+
**Quality**: ≥98% coverage • no unallowlisted vulnerabilities • 0 offenses
|
|
387
419
|
|
|
388
420
|
See [README.Development.md](README.Development.md) for details.
|
|
389
421
|
|
data/interface.yml
CHANGED
data/jekyll-documents.gemspec
CHANGED
|
@@ -9,10 +9,23 @@ Gem::Specification.new do |spec|
|
|
|
9
9
|
|
|
10
10
|
spec.summary = "Auto-generate Jekyll pages for documents (PDF/DOCX/...) " \
|
|
11
11
|
"with category/date/title parsing."
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
12
|
+
# NOTE: rubygems.org renders the description through RDoc::Markup only
|
|
13
|
+
# when it starts with an == heading at column 0 — keep the heredoc
|
|
14
|
+
# content flush-left or the page renders as one plain <p>.
|
|
15
|
+
spec.description = <<~DESC
|
|
16
|
+
== Jekyll document pages
|
|
17
|
+
|
|
18
|
+
Scans assets/documents/** into a browsable collection — one page per
|
|
19
|
+
file with title, date, category and file-type icons baked at
|
|
20
|
+
generation time — plus a Lunr JSON index and sitemap integration.
|
|
21
|
+
|
|
22
|
+
* YYYY-MM-DD_Title.ext filenames; nested categories from folders
|
|
23
|
+
* Tags: doc_link, doc_category, document_icon, latest_documents
|
|
24
|
+
* Optional text extraction cache and jekyll-client-search integration
|
|
25
|
+
|
|
26
|
+
A companion VS Code extension (jekyll-imgflow-vscode) provides tag
|
|
27
|
+
autocomplete: https://github.com/gundestrup/jekyll-imgflow-vscode
|
|
28
|
+
DESC
|
|
16
29
|
spec.homepage = "https://github.com/gundestrup/jekyll-documents"
|
|
17
30
|
spec.license = "AGPL-3.0-only"
|
|
18
31
|
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-documents
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.7.
|
|
4
|
+
version: 0.7.9
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Svend Gundestrup
|
|
@@ -29,9 +29,19 @@ dependencies:
|
|
|
29
29
|
- - "<"
|
|
30
30
|
- !ruby/object:Gem::Version
|
|
31
31
|
version: '5.0'
|
|
32
|
-
description:
|
|
33
|
-
|
|
34
|
-
|
|
32
|
+
description: |
|
|
33
|
+
== Jekyll document pages
|
|
34
|
+
|
|
35
|
+
Scans assets/documents/** into a browsable collection — one page per
|
|
36
|
+
file with title, date, category and file-type icons baked at
|
|
37
|
+
generation time — plus a Lunr JSON index and sitemap integration.
|
|
38
|
+
|
|
39
|
+
* YYYY-MM-DD_Title.ext filenames; nested categories from folders
|
|
40
|
+
* Tags: doc_link, doc_category, document_icon, latest_documents
|
|
41
|
+
* Optional text extraction cache and jekyll-client-search integration
|
|
42
|
+
|
|
43
|
+
A companion VS Code extension (jekyll-imgflow-vscode) provides tag
|
|
44
|
+
autocomplete: https://github.com/gundestrup/jekyll-imgflow-vscode
|
|
35
45
|
email:
|
|
36
46
|
- no-reply@borg-collective.eu
|
|
37
47
|
executables: []
|