RubyGems - yard-yaml - Versions diffs - 0.1.0 → 0.1.2 - Mend

yard-yaml 0.1.0 → 0.1.2

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.

Files changed (23) hide show

checksums.yaml +4 -4
checksums.yaml.gz.sig +0 -0
data/CHANGELOG.md +50 -1
data/CITATION.cff +6 -6
data/CONTRIBUTING.md +66 -31
data/FUNDING.md +1 -1
data/LICENSE.md +11 -0
data/README.md +123 -885
data/certs/pboling.pem +27 -0
data/lib/yard/yaml/converter.rb +88 -11
data/lib/yard/yaml/emitter.rb +28 -11
data/lib/yard/yaml/plugin.rb +71 -4
data/lib/yard/yaml/tag_renderer.rb +1 -1
data/lib/yard/yaml/tags.rb +3 -7
data/lib/yard/yaml/version.rb +2 -2
data/lib/yard/yaml.rb +21 -9
data/lib/yard-yaml.rb +3 -0
data/sig/yard/yaml/version.rbs +8 -0
data.tar.gz.sig +0 -0
metadata +52 -40
metadata.gz.sig +0 -0
data/LICENSE.txt +0 -21
data/REEK +0 -0

data/README.md CHANGED Viewed

@@ -1,46 +1,17 @@
-| 📍 NOTE                                                                                                                                                           |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| RubyGems (the [GitHub org][rubygems-org], not the website) [suffered][draper-security] a [hostile takeover][ellen-takeover] in September 2025.                    |
-| Ultimately [4 maintainers][simi-removed] were [hard removed][martin-removed] and a reason has been given for only 1 of those, while 2 others resigned in protest. |
-| It is a [complicated story][draper-takeover] which is difficult to [parse quickly][draper-lies].                                                                  |
-| I'm adding notes like this to gems because I [don't condone theft][draper-theft] of repositories or gems from their rightful owners.                              |
-| If a similar theft happened with my repos/gems, I'd hope some would stand up for me.                                                                              |
-| Disenfranchised former-maintainers have started [gem.coop][gem-coop].                                                                                             |
-| Once available I will publish there exclusively; unless RubyCentral makes amends with the community.                                                              |
-| The ["Technology for Humans: Joel Draper"][reinteractive-podcast] podcast episode by [reinteractive][reinteractive] is the most cogent summary I'm aware of.      |
-| See [here][gem-naming], [here][gem-coop] and [here][martin-ann] for more info on what comes next.                                                                 |
-| What I'm doing: A (WIP) proposal for [bundler/gem scopes][gem-scopes], and a (WIP) proposal for a federated [gem server][gem-server].                             |
-[rubygems-org]: https://github.com/rubygems/
-[draper-security]: https://joel.drapper.me/p/ruby-central-security-measures/
-[draper-takeover]: https://joel.drapper.me/p/ruby-central-takeover/
-[ellen-takeover]: https://pup-e.com/blog/goodbye-rubygems/
-[simi-removed]: https://www.reddit.com/r/ruby/s/gOk42POCaV
-[martin-removed]: https://bsky.app/profile/martinemde.com/post/3m3occezxxs2q
-[draper-lies]: https://joel.drapper.me/p/ruby-central-fact-check/
-[draper-theft]: https://joel.drapper.me/p/ruby-central/
-[reinteractive]: https://reinteractive.com/ruby-on-rails
-[gem-coop]: https://gem.coop
-[gem-naming]: https://github.com/gem-coop/gem.coop/issues/12
-[martin-ann]: https://martinemde.com/2025/10/05/announcing-gem-coop.html
-[gem-scopes]: https://github.com/galtzo-floss/bundle-namespace
-[gem-server]: https://github.com/galtzo-floss/gem-server
-[reinteractive-podcast]: https://youtu.be/_H4qbtC5qzU?si=BvuBU90R2wAqD2E6
-[![Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0][🖼️galtzo-i]][🖼️galtzo-discord] [![ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5][🖼️ruby-lang-i]][🖼️ruby-lang] [![yard-yaml Logo by Aboling0, CC BY-SA 4.0][🖼️yard-yaml-i]][🖼️yard-yaml]
-[🖼️galtzo-i]: https://logos.galtzo.com/assets/images/galtzo-floss/avatar-192px.svg
-[🖼️galtzo-discord]: https://discord.gg/3qme4XHNKN
+[![Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0][🖼️galtzo-floss-i]][🖼️galtzo-floss] [![ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5][🖼️ruby-lang-i]][🖼️ruby-lang] [![yard-yaml Logo by Aboling0, CC BY-SA 4.0][🖼️galtzo-floss-yard-yaml-i]][🖼️galtzo-floss-yard-yaml]
+[🖼️galtzo-floss-i]: https://logos.galtzo.com/assets/images/galtzo-floss/avatar-192px.svg
+[🖼️galtzo-floss]: https://discord.gg/3qme4XHNKN
 [🖼️ruby-lang-i]: https://logos.galtzo.com/assets/images/ruby-lang/avatar-192px.svg
 [🖼️ruby-lang]: https://www.ruby-lang.org/
-[🖼️yard-yaml-i]: https://logos.galtzo.com/assets/images/galtzo-floss/yard-yaml/avatar-192px.svg
-[🖼️yard-yaml]: https://github.com/galtzo-floss/yard-yaml
+[🖼️galtzo-floss-yard-yaml-i]: https://logos.galtzo.com/assets/images/galtzo-floss/yard-yaml/avatar-192px.svg
+[🖼️galtzo-floss-yard-yaml]: https://github.com/galtzo-floss/yard-yaml
-# 🥨 Yard::Yaml
+# 🦗 Yard::Yaml
-[![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license-ref] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![Open Source Helpers][👽oss-helpi]][👽oss-help] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Supported][🚎6-s-wfi]][🚎6-s-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![CodeQL][🖐codeQL-img]][🖐codeQL] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
+[![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![CodeQL][🖐codeQL-img]][🖐codeQL] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
-`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][🖼️galtzo-discord], as I may have missed the [discord notification][🖼️galtzo-discord].
+`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][🖼️galtzo-floss], as I may have missed the [discord notification][🖼️galtzo-floss].
 ---
@@ -48,51 +19,67 @@
 [![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate at ko-fi.com][🖇kofi-img]][🖇kofi]
+<details>
+ <summary>👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️</summary>
+I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo).
+</details>
 ## 🌻 Synopsis
 To enable the `yard-yaml` plugin add it to your Gemfile,
-and then add the following line to your `.yardopts` file:
+and then add the plugin to your `.yardopts` file:
 ```text
 --plugin yaml
 ```
-This will activate the plugin during the `yard doc` generation process, converting YAML (including CFF) files to HTML.
+When you run `yard doc`, `yard-yaml` converts those YAML documents into HTML
+documentation pages under `docs/yaml/`. For example, a root `CITATION.cff`
+with `title: my-gem` becomes a converted page like `docs/yaml/my-gem.html`.
 ## 💡 Info you can shake a stick at
-| Tokens to Remember      | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace]                                                                                                                                                                                                                                                                          |
+| Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
 |-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Works with JRuby        | [![JRuby 10.0 Compat][💎jruby-c-i]][🚎11-c-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf]                                                                                                                                                                                                                                                                     |
-| Works with Truffle Ruby | [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎9-t-wf] [![Truffle Ruby 24.1 Compat][💎truby-c-i]][🚎11-c-wf]                                                                                                                                                                                                                                                        |
-| Works with MRI Ruby 3   | [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎6-s-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎6-s-wf] [![Ruby 3.4 Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf]                                                                                                                                                                                  |
-| Support & Community     | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork] [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor]                                       |
-| Source                  | [![Source on GitLab.com][📜src-gl-img]][📜src-gl] [![Source on CodeBerg.org][📜src-cb-img]][📜src-cb] [![Source on Github.com][📜src-gh-img]][📜src-gh] [![The best SHA: dQw4w9WgXcQ!][🧮kloc-img]][🧮kloc]                                                                                                                                                         |
-| Documentation           | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head] [![Maintainer Blog][🚂maint-blog-img]][🚂maint-blog] [![GitLab Wiki][📜gl-wiki-img]][📜gl-wiki] [![GitHub Wiki][📜gh-wiki-img]][📜gh-wiki]                                                                                          |
-| Compliance              | [![License: MIT][📄license-img]][📄license-ref] [![Compatible with Apache Software Projects: Verified by SkyWalking Eyes][📄license-compat-img]][📄license-compat] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
-| Style                   | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] [![Compatibility appraised by: appraisal2][💎appraisal2-img]][💎appraisal2]                                                                                                                  |
-| Maintainer 🎖️          | [![Follow Me on LinkedIn][💖🖇linkedin-img]][💖🖇linkedin] [![Follow Me on Ruby.Social][💖🐘ruby-mast-img]][💖🐘ruby-mast] [![Follow Me on Bluesky][💖🦋bluesky-img]][💖🦋bluesky] [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact] [![My technical writing][💖💁🏼‍♂️devto-img]][💖💁🏼‍♂️devto]                                                      |
-| `...` 💖                | [![Find Me on WellFound:][💖✌️wellfound-img]][💖✌️wellfound] [![Find Me on CrunchBase][💖💲crunchbase-img]][💖💲crunchbase] [![My LinkTree][💖🌳linktree-img]][💖🌳linktree] [![More About Me][💖💁🏼‍♂️aboutme-img]][💖💁🏼‍♂️aboutme] [🧊][💖🧊berg] [🐙][💖🐙hub]  [🛖][💖🛖hut] [🧪][💖🧪lab]                                                                   |
+| Works with JRuby | [![JRuby current Compat][💎jruby-c-i]][🚎10-j-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf]|
+| Works with Truffle Ruby | [![Truffle Ruby 24.2 Compat][💎truby-24.2i]][🚎truby-24.2-wf] [![Truffle Ruby 25.0 Compat][💎truby-25.0i]][🚎truby-25.0-wf] [![Truffle Ruby current Compat][💎truby-c-i]][🚎9-t-wf]|
+| Works with MRI Ruby 4 | [![Ruby 4.0 Compat][💎ruby-4.0i]][🚎11-c-wf] [![Ruby current Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf]|
+| Works with MRI Ruby 3 | [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎ruby-3.2-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎ruby-3.3-wf] [![Ruby 3.4 Compat][💎ruby-3.4i]][🚎ruby-3.4-wf]|
+| Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork] [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor] |
+| Source | [![Source on GitLab.com][📜src-gl-img]][📜src-gl] [![Source on CodeBerg.org][📜src-cb-img]][📜src-cb] [![Source on Github.com][📜src-gh-img]][📜src-gh] [![The best SHA: dQw4w9WgXcQ!][🧮kloc-img]][🧮kloc] |
+| Documentation | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head] [![Maintainer Blog][🚂maint-blog-img]][🚂maint-blog] [![GitLab Wiki][📜gl-wiki-img]][📜gl-wiki] [![GitHub Wiki][📜gh-wiki-img]][📜gh-wiki] |
+| Compliance | [![License: MIT][📄license-img]][📄license] [![Apache license compatibility: Category A][📄license-compat-img]][📄license-compat] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
+| Style | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] [![Compatibility appraised by: appraisal2][💎appraisal2-img]][💎appraisal2] |
+| Maintainer 🎖️ | [![Follow Me on LinkedIn][💖🖇linkedin-img]][💖🖇linkedin] [![Follow Me on Ruby.Social][💖🐘ruby-mast-img]][💖🐘ruby-mast] [![Follow Me on Bluesky][💖🦋bluesky-img]][💖🦋bluesky] [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact] [![My technical writing][💖💁🏼‍♂️devto-img]][💖💁🏼‍♂️devto] |
+| `...` 💖 | [![Find Me on WellFound:][💖✌️wellfound-img]][💖✌️wellfound] [![Find Me on CrunchBase][💖💲crunchbase-img]][💖💲crunchbase] [![My LinkTree][💖🌳linktree-img]][💖🌳linktree] [![More About Me][💖💁🏼‍♂️aboutme-img]][💖💁🏼‍♂️aboutme] [🧊][💖🧊berg] [🐙][💖🐙hub] [🛖][💖🛖hut] [🧪][💖🧪lab] |
 ### Compatibility
 Compatible with MRI Ruby 3.2.0+, and concordant releases of JRuby, and TruffleRuby.
+CI workflows and Appraisals are generated for MRI Ruby 3.2.0+.
+This test floor is configured by `ruby.test_minimum` in `.kettle-jem.yml` and
+may be higher than the gem's runtime compatibility floor when legacy Rubies are
+not practical for the current toolchain.
-| 🚚 _Amazing_ test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚             |
+| 🚚 _Amazing_ test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
 |------------------------------------------------|--------------------------------------------------------|
-| 👟 Check it out!                               | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
+| 👟 Check it out! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
 ### Federated DVCS
 <details markdown="1">
-  <summary>Find this repo on federated forges (Coming soon!)</summary>
+ <summary>Find this repo on federated forges (Coming soon!)</summary>
-| Federated [DVCS][💎d-in-dvcs] Repository          | Status                                                                | Issues                    | PRs                      | Wiki                      | CI                       | Discussions                  |
-|---------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
-| 🧪 [galtzo-floss/yard-yaml on GitLab][📜src-gl]   | The Truth                                                             | [💚][🤝gl-issues]         | [💚][🤝gl-pulls]         | [💚][📜gl-wiki]           | 🐭 Tiny Matrix           | ➖                            |
-| 🧊 [galtzo-floss/yard-yaml on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate])                             | [💚][🤝cb-issues]         | [💚][🤝cb-pulls]         | ➖                         | ⭕️ No Matrix             | ➖                            |
-| 🐙 [galtzo-floss/yard-yaml on GitHub][📜src-gh]   | Another Mirror                                                        | [💚][🤝gh-issues]         | [💚][🤝gh-pulls]         | [💚][📜gh-wiki]           | 💯 Full Matrix           | [💚][gh-discussions]         |
-| 🎮️ [Discord Server][✉️discord-invite]            | [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |
+| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
+|-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
+| 🧪 [galtzo-floss/yard-yaml on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ |
+| 🧊 [galtzo-floss/yard-yaml on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
+| 🐙 [galtzo-floss/yard-yaml on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
+| 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |
 </details>
@@ -103,7 +90,7 @@ Compatible with MRI Ruby 3.2.0+, and concordant releases of JRuby, and TruffleRu
 Available as part of the Tidelift Subscription.
 <details markdown="1">
-  <summary>Need enterprise-level guarantees?</summary>
+ <summary>Need enterprise-level guarantees?</summary>
 The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.
@@ -135,41 +122,6 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install yard-yaml
 ```
-### 🔒 Secure Installation
-<details markdown="1">
-  <summary>For Medium or High Security Installations</summary>
-This gem is cryptographically signed, and has verifiable [SHA-256 and SHA-512][💎SHA_checksums] checksums by
-[stone_checksums][💎stone_checksums]. Be sure the gem you install hasn’t been tampered with
-by following the instructions below.
-Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate:
-```console
-gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)
-```
-You only need to do that once.  Then proceed to install with:
-```console
-gem install yard-yaml -P HighSecurity
-```
-The `HighSecurity` trust profile will verify signed gems, and not allow the installation of unsigned dependencies.
-If you want to up your security game full-time:
-```console
-bundle config set --global trust-policy MediumSecurity
-```
-`MediumSecurity` instead of `HighSecurity` is necessary if not all the gems you use are signed.
-NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
-</details>
 ## ⚙️ Configuration
 The `yard-yaml` plugin supports the following configuration options:
@@ -184,14 +136,17 @@ The `yard-yaml` plugin supports the following configuration options:
 - **strict**: Raise errors on conversion failures (default: `false`).
 - **allow_erb**: Allow ERB processing in YAML files (default: `false`).
-Note: Citation File Format (`.cff`) files are valid YAML and are discovered by default without needing explicit globs.
+Note: Citation File Format (`.cff`) files are valid YAML. The default
+`yard-yaml` discovery globs include root `.cff` files. Do not list YAML/CFF
+files as plain YARD inputs unless you intentionally want YARD's raw file-page
+rendering in addition to the converted `yard-yaml` page.
 ### Example `.yardopts` Configuration
 ```text
 --plugin yaml
---yard_yaml-include "examples//*.yml"
---yard_yaml-exclude "/drafts/*.yml"
+--yard_yaml-include "examples/*.yml"
+--yard_yaml-exclude "examples/drafts/*.yml"
 --yard_yaml-out_dir "custom_output"
 --yard_yaml-strict
 ```
@@ -223,17 +178,18 @@ The `yard-yaml` plugin introduces two new tags for use in docstrings:
 # @yaml_file path/to/example.yml
 ```
-#### Include .yml/.yaml files as pages
+#### Include .yml/.yaml/.cff files as pages
-- Generate docs (plugin loads; discovery config comes from flags you pass):
+- `yard-yaml` discovery defaults already include root `.yml`/`.yaml`/`.cff`
+  files and `docs/**/*.yml`, `docs/**/*.yaml`, and `docs/**/*.cff`; use
+  `--yard_yaml-include` for additional converted-page globs.
+- Generate docs:
   ```bash
   bundle exec yard
   ```
-- Then emit converted pages into your YARD output dir (replace globs/output to match your project):
-  ```bash
-  ruby -r yard/yaml -e 'Yard::Yaml::Plugin.activate(%w[--yard_yaml-include docs/**/*.y{a,}ml --yard_yaml-exclude **/_*.y{a,}ml]); Yard::Yaml::Emitter.emit!(pages: Yard::Yaml.pages, output_dir: "docs", config: Yard::Yaml.config)'
-  ```
-  Result: `docs/yaml/<slug>.html` and `docs/yaml/index.html` (when index enabled). Front matter supports `title`, `description`, `nav_order`, optional `slug`.
+  Result: `yard-yaml` writes converted pages such as `docs/yaml/<slug>.html`
+  plus `docs/yaml/index.html` when index generation is enabled. Front matter
+  supports `title`, `description`, `nav_order`, and optional `slug`.
 #### Inline YAML in Markdown (GFM) fences
@@ -246,175 +202,14 @@ The `yard-yaml` plugin introduces two new tags for use in docstrings:
     ```
     Then paste the HTML (optionally wrapped in `<div class="yyaml-inline">…</div>`).
-## Quickstart — YARD YAML Plugin
-Add the plugin and run YARD to integrate YAML into your documentation workflow.
-### 1. Install dependencies
-```bash
-bundle install
-```
-### 2. Configure `.yardopts`
-Minimal example (adjust globs/output for your project):
-```text
---plugin yaml
---markup markdown
---markup-provider kramdown
---output docs
---yard_yaml-include docs/**/*.y{a,}ml
---yard_yaml-exclude **/_*.y{a,}ml
---yard_yaml-out_dir yaml
---yard_yaml-index
-```
-NOTE: This gem uses `--plugin fence -e yard/fence/hoist.rb` for its own documentation. `yaml-fence` hoists fenced blocks inside code object docstrings, so that they are transformed to UNICODE fences before YARD sees them, to avoid the `InvalidLink` warnings, but does not convert YAML fences.
-### 3. Generate API docs & collect YAML (discovery only)
-Running `yard` loads the plugin but does not auto-emit standalone YAML pages. Discovery + conversion occur only when you explicitly activate and emit.
-```bash
-bundle exec yard
-```
-### 4. Emit standalone YAML pages (manual step)
-Invoke activation + emission in a separate Ruby process (pass the same flags you used in `.yardopts` so discovery matches):
-```bash
-ruby -r yard/yaml -e 'Yard::Yaml::Plugin.activate(%w[--yard_yaml-include docs/**/*.y{a,}ml --yard_yaml-exclude **/_*.y{a,}ml --yard_yaml-out_dir yaml --yard_yaml-index]); Yard::Yaml::Emitter.emit!(pages: Yard::Yaml.pages, output_dir: "docs", config: Yard::Yaml.config)'
-```
-Result:
-- Pages written to `docs/yaml/<slug>.html`
-- Index (if enabled) at `docs/yaml/index.html`
-- Sidebar entries (via theme hooks) link to these pages
-### 5. Inline YAML in code object docstrings
-Preferred: use tags.
-```ruby
-# @yaml
-# ---
-# title: Inline Example
-# description: Demonstrates inline conversion.
-# ---
-# a: 1
-# b: 2
-```
-```ruby
-# @yaml_file docs/config/app.yml
-```
-Theme hooks insert converted HTML right after the main docstring. Strict mode governs failure behavior.
-### 6. YAML in Markdown (GFM) fenced blocks
-Standalone Markdown pages (e.g. README sections) treat:
-~~~markdown
-```yaml
-key: value
-```
-~~~
-as a code block. This plugin does NOT yet auto-convert fenced YAML in arbitrary Markdown pages.
-Workarounds:
-- Link to emitted page: `[Full Config](./yaml/config.html)`
-- Pre-convert & paste HTML:
-  ```bash
-  ruby -r yard/yaml -e 'print Yard::Yaml::Converter.from_string(File.read(ARGV[0]))[:html]' docs/config/app.yml > tmp.html
-  ```
-  Paste the resulting HTML (Kramdown allows raw HTML). Optionally wrap:
-  ```html
-  <div class="yyaml-inline">(converted YAML html here)</div>
-  ```
-### Front Matter Support
-Example `docs/config/app.yml`:
-```yaml
----
-# Front matter fields consumed by yaml-converter
-title: Application Configuration
-nav_order: 10
-description: Core settings
-slug: app-config
----
-app:
-  name: demo
-  enabled: true
-```
-Parsed fields:
-- `title`, `description` for page heading & sidebar
-- `nav_order` for ordering
-- `slug` overrides derived slug
-### Strict Mode & Safety
-- `--yard_yaml-strict=true`: raise `Yard::Yaml::Error` on missing file, conversion, or write errors.
-- Default (non-strict): warn and skip.
-- ERB disabled by default (`allow_erb=false`); enable only if you trust sources: `--yard_yaml-allow_erb=true`.
-### Converter Options
-Customize yaml-converter behavior (example):
-```text
---yard_yaml-converter_options pretty:true,wrap:80
-```
-Boolean/number coercion is handled automatically.
-### Why not `yaml-markdown`?
-Unnecessary here. YARD already processes Markdown via `--markup markdown --markup-provider kramdown`. This plugin focuses on YAML discovery, conversion, tagging, and emission, leveraging the `yaml-converter` dependency.
-### Limitations & Roadmap
-Current limitations:
-- No automatic emission during `yard` run (manual step required)
-- No automatic conversion of fenced YAML in standalone Markdown pages
-- Minimal default HTML for emitted pages (simple inline styles)
-Planned improvements (subject to change):
-- Automatic emission hook in the generation pipeline
-- Optional fenced YAML auto-conversion in Markdown
-- Enhanced theming & TOC modes beyond `auto`
-- Search integration across YAML content
-### Troubleshooting Quick Reference
-| Symptom                    | Fix                                                      |
-|----------------------------|----------------------------------------------------------|
-| Sidebar links 404          | Run emission step (Step 4)                               |
-| Missing expected YAML page | Verify include/exclude globs & rerun emission            |
-| Inline tag shows empty     | Ensure YAML content is valid; check strict mode warnings |
-| Fenced YAML not converted  | Use tags or pre-convert & paste HTML                     |
-| ERB ignored                | Enable `--yard_yaml-allow_erb=true` (security trade-off) |
-| Build fails in strict mode | Rerun without strict to inspect warnings                 |
 ## 🦷 FLOSS Funding
 While galtzo-floss tools are free software and will always be, the project would benefit immensely from some funding.
 Raising a monthly budget of... "dollars" would make the project more sustainable.
 We welcome both individual and corporate sponsors! We also offer a
-wide array of funding channels to account for your preferences
-(although currently [Open Collective][🖇osc] is our preferred funding platform).
+wide array of funding channels to account for your preferences.
+Currently, [Open Collective][🖇osc] is our preferred funding platform.
 **If you're working in a company that's making significant use of galtzo-floss tools we'd
 appreciate it if you suggest to your company to become a galtzo-floss sponsor.**
@@ -426,7 +221,7 @@ You can support the development of galtzo-floss tools via
 [Open Collective][🖇osc]
 and [Tidelift][🏙️entsup-tidelift].
-| 📍 NOTE                                                                                                                                                                                                              |
+| 📍 NOTE |
 |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | If doing a sponsorship in the form of donation is problematic for your company <br/> from an accounting standpoint, we'd recommend the use of Tidelift, <br/> where you can get a support-like subscription instead. |
@@ -454,7 +249,7 @@ No sponsors yet. Be the first!
 ### Another way to support open-source
-I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small.  Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions.  I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).
+I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).
 If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in `bundle fund`.
@@ -471,7 +266,7 @@ See [SECURITY.md][🔐security].
 ## 🤝 Contributing
 If you need some ideas of where to help, you could work on adding more code coverage,
-or if it is already 💯 (see [below](#code-coverage)) check [reek](REEK), [issues][🤝gh-issues], or [PRs][🤝gh-pulls],
+or if it is already 💯 (see [below](#code-coverage)) check [issues][🤝gh-issues] or [PRs][🤝gh-pulls],
 or use the gem and think about how it could be better.
 We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
@@ -484,12 +279,17 @@ See [CONTRIBUTING.md][🤝contributing].
 ### Code Coverage
+<details markdown="1">
+<summary>Coverage service badges</summary>
 [![Coverage Graph][🏀codecov-g]][🏀codecov]
 [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
 [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
+</details>
 ### 🪇 Code of Conduct
 Everyone interacting with this project's codebases, issue trackers,
@@ -504,13 +304,13 @@ Made with [contributors-img][🖐contrib-rocks].
 Also see GitLab Contributors: [https://gitlab.com/galtzo-floss/yard-yaml/-/graphs/main][🚎contributors-gl]
 <details>
-    <summary>⭐️ Star History</summary>
+ <summary>⭐️ Star History</summary>
-<a href="https://star-history.com/#galtzo-floss/yard-yaml&Date">
+<a href="https://star-history.com/galtzo-floss/yard-yaml&Date">
  <picture>
-   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=galtzo-floss/yard-yaml&type=Date&theme=dark" />
-   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=galtzo-floss/yard-yaml&type=Date" />
-   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=galtzo-floss/yard-yaml&type=Date" />
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=galtzo-floss/yard-yaml&type=Date&theme=dark" />
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=galtzo-floss/yard-yaml&type=Date" />
+ <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=galtzo-floss/yard-yaml&type=Date" />
  </picture>
 </a>
@@ -518,31 +318,20 @@ Also see GitLab Contributors: [https://gitlab.com/galtzo-floss/yard-yaml/-/graph
 ## 📌 Versioning
-This Library adheres to [![Semantic Versioning 2.0.0][📌semver-img]][📌semver].
-Violations of this scheme should be reported as bugs.
-Specifically, if a minor or patch version is released that breaks backward compatibility,
-a new version should be immediately released that restores compatibility.
-Breaking changes to the public API will only be introduced with new major versions.
-> dropping support for a platform is both obviously and objectively a breaking change <br/>
->—Jordan Harband ([@ljharb](https://github.com/ljharb), maintainer of SemVer) [in SemVer issue 716][📌semver-breaking]
-I understand that policy doesn't work universally ("exceptions to every rule!"),
-but it is the policy here.
-As such, in many cases it is good to specify a dependency on this library using
-the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
+This library follows [![Semantic Versioning 2.0.0][📌semver-img]][📌semver] for its public API where practical.
+For most applications, prefer the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
 For example:
 ```ruby
-spec.add_dependency("yard-yaml", "~> 1.0")
+spec.add_dependency("yard-yaml", "~> 0.0")
 ```
 <details markdown="1">
 <summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
-SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms
-is a *breaking change* to an API, and for that reason the bike shedding is endless.
+Dropping support for a platform can be a breaking change for affected users.
+If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.
 To get a better understanding of how SemVer is intended to work over a project's lifetime,
 read this article from the creator of SemVer:
@@ -556,569 +345,20 @@ See [CHANGELOG.md][📌changelog] for a list of releases.
 ## 📄 License
 The gem is available as open source under the terms of
-the [MIT License][📄license] [![License: MIT][📄license-img]][📄license-ref].
-See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright-notice-explainer].
+the [MIT](MIT.md) [![License: MIT][📄license-img]][📄license-ref].
 ### © Copyright
-<ul>
-    <li>
-        Copyright (c) 2025 Aboling0 & Peter H. Boling, of
-        <a href="https://discord.gg/3qme4XHNKN">
-            Galtzo.com
-            <picture>
-              <img src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px-blank.svg" alt="Galtzo.com Logo (Wordless) by Aboling0, CC BY-SA 4.0" width="24">
-            </picture>
-        </a>, and yard-yaml contributors.
-    </li>
-</ul>
-## 🤑 A request for help
-Maintainers have teeth and need to pay their dentists.
-After getting laid off in an RIF in March, and encountering difficulty finding a new one,
-I began spending most of my time building open source tools.
-I'm hoping to be able to pay for my kids' health insurance this month,
-so if you value the work I am doing, I need your support.
-Please consider sponsoring me or the project.
-To join the community or get help 👇️ Join the Discord.
-[![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
-To say "thanks!" ☝️ Join the Discord or 👇️ send money.
-[![Sponsor galtzo-floss/yard-yaml on Open Source Collective][🖇osc-all-bottom-img]][🖇osc] 💌 [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal]
-### Please give the project a star ⭐ ♥.
-Thanks for RTFM. ☺️
-[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
-[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
-[⛳liberapay]: https://liberapay.com/pboling/donate
-[🖇osc-all-img]: https://img.shields.io/opencollective/all/galtzo-floss
-[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/galtzo-floss
-[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/galtzo-floss
-[🖇osc-backers]: https://opencollective.com/galtzo-floss#backer
-[🖇osc-backers-i]: https://opencollective.com/galtzo-floss/backers/badge.svg?style=flat
-[🖇osc-sponsors]: https://opencollective.com/galtzo-floss#sponsor
-[🖇osc-sponsors-i]: https://opencollective.com/galtzo-floss/sponsors/badge.svg?style=flat
-[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/galtzo-floss?style=for-the-badge
-[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/galtzo-floss?style=for-the-badge
-[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/galtzo-floss?style=for-the-badge
-[🖇osc]: https://opencollective.com/galtzo-floss
-[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
-[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
-[🖇sponsor]: https://github.com/sponsors/pboling
-[🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
-[🖇polar]: https://polar.sh/pboling
-[🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
-[🖇kofi]: https://ko-fi.com/O5O86SNP4
-[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
-[🖇patreon]: https://patreon.com/galtzo
-[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
-[🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
-[🖇buyme]: https://www.buymeacoffee.com/pboling
-[🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
-[🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
-[🖇paypal]: https://www.paypal.com/paypalme/peterboling
-[🖇floss-funding.dev]: https://floss-funding.dev
-[🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
-[✉️discord-invite]: https://discord.gg/3qme4XHNKN
-[✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
-[✉️ruby-friends-img]: https://img.shields.io/badge/daily.dev-%F0%9F%92%8E_Ruby_Friends-0A0A0A?style=for-the-badge&logo=dailydotdev&logoColor=white
-[✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
-[✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
-[⛳️gem-namespace]: https://github.com/galtzo-floss/yard-yaml
-[⛳️namespace-img]: https://img.shields.io/badge/namespace-Yard::Yaml-3C2D2D.svg?style=square&logo=ruby&logoColor=white
-[⛳️gem-name]: https://bestgems.org/gems/yard-yaml
-[⛳️name-img]: https://img.shields.io/badge/name-yard--yaml-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
-[⛳️tag-img]: https://img.shields.io/github/tag/galtzo-floss/yard-yaml.svg
-[⛳️tag]: http://github.com/galtzo-floss/yard-yaml/releases
-[🚂maint-blog]: http://www.railsbling.com/tags/yard-yaml
-[🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
-[🚂maint-contact]: http://www.railsbling.com/contact
-[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
-[💖🖇linkedin]: http://www.linkedin.com/in/peterboling
-[💖🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-LinkedIn-0B66C2?style=flat&logo=newjapanprowrestling
-[💖✌️wellfound]: https://wellfound.com/u/peter-boling
-[💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
-[💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
-[💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
-[💖🐘ruby-mast]: https://ruby.social/@galtzo
-[💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=flat&logo=mastodon&label=Ruby%20@galtzo
-[💖🦋bluesky]: https://bsky.app/profile/galtzo.com
-[💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
-[💖🌳linktree]: https://linktr.ee/galtzo
-[💖🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree
-[💖💁🏼‍♂️devto]: https://dev.to/galtzo
-[💖💁🏼‍♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
-[💖💁🏼‍♂️aboutme]: https://about.me/peter.boling
-[💖💁🏼‍♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
-[💖🧊berg]: https://codeberg.org/pboling
-[💖🐙hub]: https://github.org/pboling
-[💖🛖hut]: https://sr.ht/~galtzo/
-[💖🧪lab]: https://gitlab.com/pboling
-[👨🏼‍🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
-[👨🏼‍🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
-[👨🏼‍🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
-[👨🏼‍🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
-[🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-yard-yaml?utm_source=rubygems-yard-yaml&utm_medium=referral&utm_campaign=readme
-[🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
-[🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
-[💁🏼‍♂️peterboling]: http://www.peterboling.com
-[🚂railsbling]: http://www.railsbling.com
-[📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
-[📜src-gl]: https://gitlab.com/galtzo-floss/yard-yaml/
-[📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
-[📜src-cb]: https://codeberg.org/galtzo-floss/yard-yaml
-[📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
-[📜src-gh]: https://github.com/galtzo-floss/yard-yaml
-[📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
-[📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
-[📜gl-wiki]: https://gitlab.com/galtzo-floss/yard-yaml/-/wikis/home
-[📜gh-wiki]: https://github.com/galtzo-floss/yard-yaml/wiki
-[📜gl-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
-[📜gh-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
-[👽dl-rank]: https://bestgems.org/gems/yard-yaml
-[👽dl-ranki]: https://img.shields.io/gem/rd/yard-yaml.svg
-[👽oss-help]: https://www.codetriage.com/galtzo-floss/yard-yaml
-[👽oss-helpi]: https://www.codetriage.com/galtzo-floss/yard-yaml/badges/users.svg
-[👽version]: https://bestgems.org/gems/yard-yaml
-[👽versioni]: https://img.shields.io/gem/v/yard-yaml.svg
-[🏀qlty-mnt]: https://qlty.sh/gh/galtzo-floss/projects/yard-yaml
-[🏀qlty-mnti]: https://qlty.sh/gh/galtzo-floss/projects/yard-yaml/maintainability.svg
-[🏀qlty-cov]: https://qlty.sh/gh/galtzo-floss/projects/yard-yaml/metrics/code?sort=coverageRating
-[🏀qlty-covi]: https://qlty.sh/gh/galtzo-floss/projects/yard-yaml/coverage.svg
-[🏀codecov]: https://codecov.io/gh/galtzo-floss/yard-yaml
-[🏀codecovi]: https://codecov.io/gh/galtzo-floss/yard-yaml/graph/badge.svg
-[🏀coveralls]: https://coveralls.io/github/galtzo-floss/yard-yaml?branch=main
-[🏀coveralls-img]: https://coveralls.io/repos/github/galtzo-floss/yard-yaml/badge.svg?branch=main
-[🖐codeQL]: https://github.com/galtzo-floss/yard-yaml/security/code-scanning
-[🖐codeQL-img]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/codeql-analysis.yml/badge.svg
-[🚎1-an-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/ancient.yml
-[🚎1-an-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/ancient.yml/badge.svg
-[🚎2-cov-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/coverage.yml
-[🚎2-cov-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/coverage.yml/badge.svg
-[🚎3-hd-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/heads.yml
-[🚎3-hd-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/heads.yml/badge.svg
-[🚎4-lg-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/legacy.yml
-[🚎4-lg-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/legacy.yml/badge.svg
-[🚎5-st-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/style.yml
-[🚎5-st-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/style.yml/badge.svg
-[🚎6-s-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/supported.yml
-[🚎6-s-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/supported.yml/badge.svg
-[🚎7-us-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/unsupported.yml
-[🚎7-us-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/unsupported.yml/badge.svg
-[🚎8-ho-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/hoary.yml
-[🚎8-ho-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/hoary.yml/badge.svg
-[🚎9-t-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/truffle.yml
-[🚎9-t-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/truffle.yml/badge.svg
-[🚎10-j-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/jruby.yml
-[🚎10-j-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/jruby.yml/badge.svg
-[🚎11-c-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/current.yml
-[🚎11-c-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/current.yml/badge.svg
-[🚎12-crh-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/dep-heads.yml
-[🚎12-crh-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/dep-heads.yml/badge.svg
-[🚎13-🔒️-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/locked_deps.yml
-[🚎13-🔒️-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/locked_deps.yml/badge.svg
-[🚎14-🔓️-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/unlocked_deps.yml
-[🚎14-🔓️-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/unlocked_deps.yml/badge.svg
-[🚎15-🪪-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/license-eye.yml
-[🚎15-🪪-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/license-eye.yml/badge.svg
-[💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
-[💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
-[💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
-[💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
-[💎truby-22.3i]: https://img.shields.io/badge/Truffle_Ruby-22.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
-[💎truby-23.0i]: https://img.shields.io/badge/Truffle_Ruby-23.0_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
-[💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.1-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
-[💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
-[💎truby-headi]: https://img.shields.io/badge/Truffle_Ruby-HEAD-34BCB1?style=for-the-badge&logo=ruby&logoColor=blue
-[💎jruby-9.1i]: https://img.shields.io/badge/JRuby-9.1_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
-[💎jruby-9.2i]: https://img.shields.io/badge/JRuby-9.2_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
-[💎jruby-9.3i]: https://img.shields.io/badge/JRuby-9.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
-[💎jruby-9.4i]: https://img.shields.io/badge/JRuby-9.4-FBE742?style=for-the-badge&logo=ruby&logoColor=red
-[💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
-[💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
-[🤝gh-issues]: https://github.com/galtzo-floss/yard-yaml/issues
-[🤝gh-pulls]: https://github.com/galtzo-floss/yard-yaml/pulls
-[🤝gl-issues]: https://gitlab.com/galtzo-floss/yard-yaml/-/issues
-[🤝gl-pulls]: https://gitlab.com/galtzo-floss/yard-yaml/-/merge_requests
-[🤝cb-issues]: https://codeberg.org/galtzo-floss/yard-yaml/issues
-[🤝cb-pulls]: https://codeberg.org/galtzo-floss/yard-yaml/pulls
-[🤝cb-donate]: https://donate.codeberg.org/
-[🤝contributing]: CONTRIBUTING.md
-[🏀codecov-g]: https://codecov.io/gh/galtzo-floss/yard-yaml/graphs/tree.svg
-[🖐contrib-rocks]: https://contrib.rocks
-[🖐contributors]: https://github.com/galtzo-floss/yard-yaml/graphs/contributors
-[🖐contributors-img]: https://contrib.rocks/image?repo=galtzo-floss/yard-yaml
-[🚎contributors-gl]: https://gitlab.com/galtzo-floss/yard-yaml/-/graphs/main
-[🪇conduct]: CODE_OF_CONDUCT.md
-[🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
-[📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
-[📌semver]: https://semver.org/spec/v2.0.0.html
-[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
-[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
-[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
-[📌changelog]: CHANGELOG.md
-[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
-[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
-[📌gitmoji]: https://gitmoji.dev
-[📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
-[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
-[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.462-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
-[🔐security]: SECURITY.md
-[🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
-[📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
-[📄license]: LICENSE.txt
-[📄license-ref]: https://opensource.org/licenses/MIT
-[📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
-[📄license-compat]: https://dev.to/galtzo/how-to-check-license-compatibility-41h0
-[📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-%E2%9C%93-259D6C.svg?style=flat&logo=Apache
-[📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
-[📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
-[🚎yard-current]: http://rubydoc.info/gems/yard-yaml
-[🚎yard-head]: https://yard-yaml.galtzo.com
-[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
-[💎SHA_checksums]: https://gitlab.com/galtzo-floss/yard-yaml/-/tree/main/checksums
-[💎rlts]: https://github.com/rubocop-lts/rubocop-lts
-[💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
-[💎appraisal2]: https://github.com/appraisal-rb/appraisal2
-[💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
-[💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
-## Quickstart — YARD YAML Plugin
-Add the plugin and run YARD to integrate YAML into your documentation workflow.
-### 1. Install dependencies
-```bash
-bundle install
-```
-### 2. Configure `.yardopts`
-Minimal example (adjust globs/output for your project):
-```text
---plugin yaml
---markup markdown
---markup-provider kramdown
---output docs
---yard_yaml-include docs/**/*.y{a,}ml
---yard_yaml-exclude **/_*.y{a,}ml
---yard_yaml-out_dir yaml
---yard_yaml-index
-```
-NOTE: This gem uses `--plugin fence -e yard/fence/hoist.rb` for its own documentation. `yaml-fence` hoists fenced blocks inside code object docstrings, so that they are transformed to UNICODE fences before YARD sees them, to avoid the `InvalidLink` warnings, but does not convert YAML fences.
-### 3. Generate API docs & collect YAML (discovery only)
-Running `yard` loads the plugin but does not auto-emit standalone YAML pages. Discovery + conversion occur only when you explicitly activate and emit.
-```bash
-bundle exec yard
-```
-### 4. Emit standalone YAML pages (manual step)
-Invoke activation + emission in a separate Ruby process (pass the same flags you used in `.yardopts` so discovery matches):
-```bash
-ruby -r yard/yaml -e 'Yard::Yaml::Plugin.activate(%w[--yard_yaml-include docs/**/*.y{a,}ml --yard_yaml-exclude **/_*.y{a,}ml --yard_yaml-out_dir yaml --yard_yaml-index]); Yard::Yaml::Emitter.emit!(pages: Yard::Yaml.pages, output_dir: "docs", config: Yard::Yaml.config)'
-```
-Result:
-- Pages written to `docs/yaml/<slug>.html`
-- Index (if enabled) at `docs/yaml/index.html`
-- Sidebar entries (via theme hooks) link to these pages
-### 5. Inline YAML in code object docstrings
-Preferred: use tags.
-```ruby
-# @yaml
-# ---
-# title: Inline Example
-# description: Demonstrates inline conversion.
-# ---
-# a: 1
-# b: 2
-```
-```ruby
-# @yaml_file docs/config/app.yml
-```
-Theme hooks insert converted HTML right after the main docstring. Strict mode governs failure behavior.
-### 6. YAML in Markdown (GFM) fenced blocks
-Standalone Markdown pages (e.g. README sections) treat:
-````markdown
-```yaml
-key: value
-```
-````
-as a code block. This plugin does NOT yet auto-convert fenced YAML in arbitrary Markdown pages.
-Workarounds:
-- Link to emitted page: `[Full Config](./yaml/config.html)`
-- Pre-convert & paste HTML:
-  ```bash
-  ruby -r yard/yaml -e 'print Yard::Yaml::Converter.from_string(File.read(ARGV[0]))[:html]' docs/config/app.yml > tmp.html
-  ```
-  Paste the resulting HTML (Kramdown allows raw HTML). Optionally wrap:
-  ```html
-  <div class="yyaml-inline">(converted YAML html here)</div>
-  ```
-### Front Matter Support
-Example `docs/config/app.yml`:
-```yaml
----
-# Front matter fields consumed by yaml-converter
-title: Application Configuration
-nav_order: 10
-description: Core settings
-slug: app-config
----
-app:
-  name: demo
-  enabled: true
-```
-Parsed fields:
-- `title`, `description` for page heading & sidebar
-- `nav_order` for ordering
-- `slug` overrides derived slug
-### Strict Mode & Safety
-- `--yard_yaml-strict=true`: raise `Yard::Yaml::Error` on missing file, conversion, or write errors.
-- Default (non-strict): warn and skip.
-- ERB disabled by default (`allow_erb=false`); enable only if you trust sources: `--yard_yaml-allow_erb=true`.
-### Converter Options
-Customize yaml-converter behavior (example):
-```text
---yard_yaml-converter_options pretty:true,wrap:80
-```
-Boolean/number coercion is handled automatically.
-### Why not `yaml-markdown`?
-Unnecessary here. YARD already processes Markdown via `--markup markdown --markup-provider kramdown`. This plugin focuses on YAML discovery, conversion, tagging, and emission, leveraging the `yaml-converter` dependency.
-### Limitations & Roadmap
-Current limitations:
-- No automatic emission during `yard` run (manual step required)
-- No automatic conversion of fenced YAML in standalone Markdown pages
-- Minimal default HTML for emitted pages (simple inline styles)
-Planned improvements (subject to change):
-- Automatic emission hook in the generation pipeline
-- Optional fenced YAML auto-conversion in Markdown
-- Enhanced theming & TOC modes beyond `auto`
-- Search integration across YAML content
-### Troubleshooting Quick Reference
-| Symptom                    | Fix                                                      |
-|----------------------------|----------------------------------------------------------|
-| Sidebar links 404          | Run emission step (Step 4)                               |
-| Missing expected YAML page | Verify include/exclude globs & rerun emission            |
-| Inline tag shows empty     | Ensure YAML content is valid; check strict mode warnings |
-| Fenced YAML not converted  | Use tags or pre-convert & paste HTML                     |
-| ERB ignored                | Enable `--yard_yaml-allow_erb=true` (security trade-off) |
-| Build fails in strict mode | Rerun without strict to inspect warnings                 |
-## 🦷 FLOSS Funding
-While galtzo-floss tools are free software and will always be, the project would benefit immensely from some funding.
-Raising a monthly budget of... "dollars" would make the project more sustainable.
-We welcome both individual and corporate sponsors! We also offer a
-wide array of funding channels to account for your preferences
-(although currently [Open Collective][🖇osc] is our preferred funding platform).
-**If you're working in a company that's making significant use of galtzo-floss tools we'd
-appreciate it if you suggest to your company to become a galtzo-floss sponsor.**
-You can support the development of galtzo-floss tools via
-[GitHub Sponsors][🖇sponsor],
-[Liberapay][⛳liberapay],
-[PayPal][🖇paypal],
-[Open Collective][🖇osc]
-and [Tidelift][🏙️entsup-tidelift].
-| 📍 NOTE                                                                                                                                                                                                              |
-|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| If doing a sponsorship in the form of donation is problematic for your company <br/> from an accounting standpoint, we'd recommend the use of Tidelift, <br/> where you can get a support-like subscription instead. |
-### Open Collective for Individuals
-Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/galtzo-floss#backer)]
-NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
-<!-- OPENCOLLECTIVE-INDIVIDUALS:START -->
-No backers yet. Be the first!
-<!-- OPENCOLLECTIVE-INDIVIDUALS:END -->
-### Open Collective for Organizations
-Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/galtzo-floss#sponsor)]
-NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
-<!-- OPENCOLLECTIVE-ORGANIZATIONS:START -->
-No sponsors yet. Be the first!
-<!-- OPENCOLLECTIVE-ORGANIZATIONS:END -->
-[kettle-readme-backers]: https://github.com/galtzo-floss/yard-yaml/blob/main/exe/kettle-readme-backers
-### Another way to support open-source
-I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small.  Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions.  I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).
-If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in `bundle fund`.
-I’m developing a new library, [floss_funding][🖇floss-funding-gem], designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
-**[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
-[![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS efforts using Patreon][🖇patreon-img]][🖇patreon]
-## 🔐 Security
-See [SECURITY.md][🔐security].
-## 🤝 Contributing
-If you need some ideas of where to help, you could work on adding more code coverage,
-or if it is already 💯 (see [below](#code-coverage)) check [reek](REEK), [issues][🤝gh-issues], or [PRs][🤝gh-pulls],
-or use the gem and think about how it could be better.
-We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
-See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
-### 🚀 Release Instructions
-See [CONTRIBUTING.md][🤝contributing].
-### Code Coverage
-[![Coverage Graph][🏀codecov-g]][🏀codecov]
-[![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
-[![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
-### 🪇 Code of Conduct
-Everyone interacting with this project's codebases, issue trackers,
-chat rooms and mailing lists agrees to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
-## 🌈 Contributors
-[![Contributors][🖐contributors-img]][🖐contributors]
-Made with [contributors-img][🖐contrib-rocks].
-Also see GitLab Contributors: [https://gitlab.com/galtzo-floss/yard-yaml/-/graphs/main][🚎contributors-gl]
-<details>
-    <summary>⭐️ Star History</summary>
-<a href="https://star-history.com/#galtzo-floss/yard-yaml&Date">
- <picture>
-   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=galtzo-floss/yard-yaml&type=Date&theme=dark" />
-   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=galtzo-floss/yard-yaml&type=Date" />
-   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=galtzo-floss/yard-yaml&type=Date" />
- </picture>
-</a>
-</details>
-## 📌 Versioning
-This Library adheres to [![Semantic Versioning 2.0.0][📌semver-img]][📌semver].
-Violations of this scheme should be reported as bugs.
-Specifically, if a minor or patch version is released that breaks backward compatibility,
-a new version should be immediately released that restores compatibility.
-Breaking changes to the public API will only be introduced with new major versions.
-> dropping support for a platform is both obviously and objectively a breaking change <br/>
->—Jordan Harband ([@ljharb](https://github.com/ljharb), maintainer of SemVer) [in SemVer issue 716][📌semver-breaking]
-I understand that policy doesn't work universally ("exceptions to every rule!"),
-but it is the policy here.
-As such, in many cases it is good to specify a dependency on this library using
-the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
-For example:
-```ruby
-spec.add_dependency("yard-yaml", "~> 1.0")
-```
+See [LICENSE.md][📄license] for the official copyright notice.
 <details markdown="1">
-<summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
-SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms
-is a *breaking change* to an API, and for that reason the bike shedding is endless.
-To get a better understanding of how SemVer is intended to work over a project's lifetime,
-read this article from the creator of SemVer:
+<summary>Copyright holders</summary>
-- ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
+- Copyright (c) 2025 Annibelle Boling
+- Copyright (c) 2025-2026 Peter H. Boling
 </details>
-See [CHANGELOG.md][📌changelog] for a list of releases.
-## 📄 License
-The gem is available as open source under the terms of
-the [MIT License][📄license] [![License: MIT][📄license-img]][📄license-ref].
-See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright-notice-explainer].
-### © Copyright
-<ul>
-    <li>
-        Copyright (c) 2025 Aboling0 & Peter H. Boling, of
-        <a href="https://discord.gg/3qme4XHNKN">
-            Galtzo.com
-            <picture>
-              <img src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px-blank.svg" alt="Galtzo.com Logo (Wordless) by Aboling0, CC BY-SA 4.0" width="24">
-            </picture>
-        </a>, and yard-yaml contributors.
-    </li>
-</ul>
 ## 🤑 A request for help
 Maintainers have teeth and need to pay their dentists.
@@ -1160,7 +400,7 @@ Thanks for RTFM. ☺️
 [🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
 [🖇polar]: https://polar.sh/pboling
 [🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
-[🖇kofi]: https://ko-fi.com/O5O86SNP4
+[🖇kofi]: https://ko-fi.com/pboling
 [🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
 [🖇patreon]: https://patreon.com/galtzo
 [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
@@ -1182,13 +422,13 @@ Thanks for RTFM. ☺️
 [⛳️gem-name]: https://bestgems.org/gems/yard-yaml
 [⛳️name-img]: https://img.shields.io/badge/name-yard--yaml-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
 [⛳️tag-img]: https://img.shields.io/github/tag/galtzo-floss/yard-yaml.svg
-[⛳️tag]: http://github.com/galtzo-floss/yard-yaml/releases
+[⛳️tag]: https://github.com/galtzo-floss/yard-yaml/releases
 [🚂maint-blog]: http://www.railsbling.com/tags/yard-yaml
 [🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
 [🚂maint-contact]: http://www.railsbling.com/contact
 [🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
 [💖🖇linkedin]: http://www.linkedin.com/in/peterboling
-[💖🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-LinkedIn-0B66C2?style=flat&logo=newjapanprowrestling
+[💖🖇linkedin-img]: https://img.shields.io/badge/LinkedIn-Profile-0B66C2?style=flat&logo=newjapanprowrestling
 [💖✌️wellfound]: https://wellfound.com/u/peter-boling
 [💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
 [💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
@@ -1217,7 +457,7 @@ Thanks for RTFM. ☺️
 [💁🏼‍♂️peterboling]: http://www.peterboling.com
 [🚂railsbling]: http://www.railsbling.com
 [📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
-[📜src-gl]: https://gitlab.com/galtzo-floss/yard-yaml/
+[📜src-gl]: https://gitlab.com/galtzo-floss/yard-yaml
 [📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
 [📜src-cb]: https://codeberg.org/galtzo-floss/yard-yaml
 [📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
@@ -1226,12 +466,10 @@ Thanks for RTFM. ☺️
 [📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
 [📜gl-wiki]: https://gitlab.com/galtzo-floss/yard-yaml/-/wikis/home
 [📜gh-wiki]: https://github.com/galtzo-floss/yard-yaml/wiki
-[📜gl-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
-[📜gh-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
+[📜gl-wiki-img]: https://img.shields.io/badge/wiki-gitlab-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
+[📜gh-wiki-img]: https://img.shields.io/badge/wiki-github-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
 [👽dl-rank]: https://bestgems.org/gems/yard-yaml
 [👽dl-ranki]: https://img.shields.io/gem/rd/yard-yaml.svg
-[👽oss-help]: https://www.codetriage.com/galtzo-floss/yard-yaml
-[👽oss-helpi]: https://www.codetriage.com/galtzo-floss/yard-yaml/badges/users.svg
 [👽version]: https://bestgems.org/gems/yard-yaml
 [👽versioni]: https://img.shields.io/gem/v/yard-yaml.svg
 [🏀qlty-mnt]: https://qlty.sh/gh/galtzo-floss/projects/yard-yaml
@@ -1244,22 +482,17 @@ Thanks for RTFM. ☺️
 [🏀coveralls-img]: https://coveralls.io/repos/github/galtzo-floss/yard-yaml/badge.svg?branch=main
 [🖐codeQL]: https://github.com/galtzo-floss/yard-yaml/security/code-scanning
 [🖐codeQL-img]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/codeql-analysis.yml/badge.svg
-[🚎1-an-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/ancient.yml
-[🚎1-an-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/ancient.yml/badge.svg
+[🚎ruby-3.2-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/ruby-3.2.yml
+[🚎ruby-3.3-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/ruby-3.3.yml
+[🚎ruby-3.4-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/ruby-3.4.yml
+[🚎truby-24.2-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/truffleruby-24.2.yml
+[🚎truby-25.0-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/truffleruby-25.0.yml
 [🚎2-cov-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/coverage.yml
 [🚎2-cov-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/coverage.yml/badge.svg
 [🚎3-hd-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/heads.yml
 [🚎3-hd-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/heads.yml/badge.svg
-[🚎4-lg-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/legacy.yml
-[🚎4-lg-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/legacy.yml/badge.svg
 [🚎5-st-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/style.yml
 [🚎5-st-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/style.yml/badge.svg
-[🚎6-s-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/supported.yml
-[🚎6-s-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/supported.yml/badge.svg
-[🚎7-us-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/unsupported.yml
-[🚎7-us-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/unsupported.yml/badge.svg
-[🚎8-ho-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/hoary.yml
-[🚎8-ho-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/hoary.yml/badge.svg
 [🚎9-t-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/truffle.yml
 [🚎9-t-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/truffle.yml/badge.svg
 [🚎10-j-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/jruby.yml
@@ -1276,17 +509,13 @@ Thanks for RTFM. ☺️
 [🚎15-🪪-wfi]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/license-eye.yml/badge.svg
 [💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
 [💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-3.4i]: https://img.shields.io/badge/Ruby-3.4-CC342D?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-4.0i]: https://img.shields.io/badge/Ruby-4.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
 [💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
 [💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
-[💎truby-22.3i]: https://img.shields.io/badge/Truffle_Ruby-22.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
-[💎truby-23.0i]: https://img.shields.io/badge/Truffle_Ruby-23.0_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
-[💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.1-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
+[💎truby-24.2i]: https://img.shields.io/badge/Truffle_Ruby-24.2-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
+[💎truby-25.0i]: https://img.shields.io/badge/Truffle_Ruby-25.0-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
 [💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
-[💎truby-headi]: https://img.shields.io/badge/Truffle_Ruby-HEAD-34BCB1?style=for-the-badge&logo=ruby&logoColor=blue
-[💎jruby-9.1i]: https://img.shields.io/badge/JRuby-9.1_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
-[💎jruby-9.2i]: https://img.shields.io/badge/JRuby-9.2_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
-[💎jruby-9.3i]: https://img.shields.io/badge/JRuby-9.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
-[💎jruby-9.4i]: https://img.shields.io/badge/JRuby-9.4-FBE742?style=for-the-badge&logo=ruby&logoColor=red
 [💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
 [💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
 [🤝gh-issues]: https://github.com/galtzo-floss/yard-yaml/issues
@@ -1296,34 +525,35 @@ Thanks for RTFM. ☺️
 [🤝cb-issues]: https://codeberg.org/galtzo-floss/yard-yaml/issues
 [🤝cb-pulls]: https://codeberg.org/galtzo-floss/yard-yaml/pulls
 [🤝cb-donate]: https://donate.codeberg.org/
-[🤝contributing]: CONTRIBUTING.md
-[🏀codecov-g]: https://codecov.io/gh/galtzo-floss/yard-yaml/graphs/tree.svg
+[🤝contributing]: https://github.com/galtzo-floss/yard-yaml/blob/main/CONTRIBUTING.md
+[🏀codecov-g]: https://codecov.io/gh/galtzo-floss/yard-yaml/graph/badge.svg
 [🖐contrib-rocks]: https://contrib.rocks
 [🖐contributors]: https://github.com/galtzo-floss/yard-yaml/graphs/contributors
 [🖐contributors-img]: https://contrib.rocks/image?repo=galtzo-floss/yard-yaml
 [🚎contributors-gl]: https://gitlab.com/galtzo-floss/yard-yaml/-/graphs/main
-[🪇conduct]: CODE_OF_CONDUCT.md
+[🪇conduct]: https://github.com/galtzo-floss/yard-yaml/blob/main/CODE_OF_CONDUCT.md
 [🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
 [📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
 [📌semver]: https://semver.org/spec/v2.0.0.html
 [📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
 [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
 [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
-[📌changelog]: CHANGELOG.md
+[📌changelog]: https://github.com/galtzo-floss/yard-yaml/blob/main/CHANGELOG.md
 [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
 [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
 [📌gitmoji]: https://gitmoji.dev
 [📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
 [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
-[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.462-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
-[🔐security]: SECURITY.md
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.547-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🔐security]: https://github.com/galtzo-floss/yard-yaml/blob/main/SECURITY.md
 [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
 [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
-[📄license]: LICENSE.txt
-[📄license-ref]: https://opensource.org/licenses/MIT
+[📄license]: LICENSE.md
+[📄license-ref]: MIT.md
 [📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
-[📄license-compat]: https://dev.to/galtzo/how-to-check-license-compatibility-41h0
-[📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-%E2%9C%93-259D6C.svg?style=flat&logo=Apache
+[📄license-compat]: https://www.apache.org/legal/resolved.html#category-a
+[📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-✓-259D6C.svg?style=flat&logo=Apache
 [📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
 [📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
 [🚎yard-current]: http://rubydoc.info/gems/yard-yaml
@@ -1336,5 +566,13 @@ Thanks for RTFM. ☺️
 [💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
 [💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
+<!-- kettle-jem:metadata:start -->
+| Field | Value |
+|---|---|
+| Package | yard-yaml |
+| Description | 🦗 A YARD plugin for YAML documents |
+| Homepage | https://github.com/galtzo-floss/yard-yaml |
+| Source | https://github.com/galtzo-floss/yard-yaml/tree/v0.1.2 |
+| License | `MIT` |
+| Funding | https://github.com/sponsors/pboling, https://issuehunt.io/u/pboling, https://ko-fi.com/pboling, https://liberapay.com/pboling/donate, https://opencollective.com/galtzo-floss, https://patreon.com/galtzo, https://polar.sh/pboling, https://thanks.dev/u/gh/pboling, https://tidelift.com/funding/github/rubygems/yard-yaml, https://www.buymeacoffee.com/pboling |
+<!-- kettle-jem:metadata:end -->