🦗 Yard::Yaml

if ci_badges.map(&:color).detect { it != "green"} ☝️ let me know, as I may have missed the discord notification.

if ci_badges.map(&:color).all? { it == "green"} 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.

I've summarized my thoughts in this blog post.

To enable the yard-yaml plugin add it to your Gemfile, and then add the plugin to your .yardopts file:

--plugin yaml

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.

Tokens to Remember
Works with JRuby
Works with Truffle Ruby
Works with MRI Ruby 4
Works with MRI Ruby 3
Support & Community
Source
Documentation
Compliance
Style
Maintainer 🎖️
... 💖	🧊 🐙 🛖 🧪

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.

Federated DVCS Repository	Status	Issues	PRs	Wiki	CI	Discussions
🧪 galtzo-floss/yard-yaml on GitLab	The Truth	💚	💚	💚	🐭 Tiny Matrix	➖
🧊 galtzo-floss/yard-yaml on CodeBerg	An Ethical Mirror (Donate)	💚	💚	➖	⭕️ No Matrix	➖
🐙 galtzo-floss/yard-yaml on GitHub	Another Mirror	💚	💚	💚	💯 Full Matrix	💚
🎮️ Discord Server		Let's	talk	about	this	library!

Available as part of the Tidelift Subscription.

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.

• 💡Subscribe for support guarantees covering all your FLOSS dependencies
• 💡Tidelift is part of Sonar
• 💡Tidelift pays maintainers to maintain the software you depend on!
  📊@Pointy Haired Boss: An enterprise support subscription is "never gonna let you down", and supports open source maintainers

Alternatively:

Install the gem and add to the application's Gemfile by executing:

bundle add yard-yaml

If bundler is not being used to manage dependencies, install the gem by executing:

gem install yard-yaml

The yard-yaml plugin supports the following configuration options:

• include: Array of file patterns to include (default: ["docs/**/*.y{a,}ml", "*.y{a,}ml", "docs/**/*.cff", "*.cff"]).
• exclude: Array of file patterns to exclude (default: ["**/_*.y{a,}ml", "**/_*.cff"]).
• out_dir: Output directory for YAML files (default: "yaml").
• index: Whether to generate an index page (default: true).
• toc: Table of contents generation mode (default: "auto").
• converter_options: Options passed to the YAML converter (default: {}).
• front_matter: Whether to parse front matter (default: true).
• 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. 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.

--plugin yaml
--yard_yaml-include "examples/*.yml"
--yard_yaml-exclude "examples/drafts/*.yml"
--yard_yaml-out_dir "custom_output"
--yard_yaml-strict

The yard-yaml plugin introduces two new tags for use in docstrings:

1. @yaml: Embeds converted YAML content as HTML.
2. @yaml_file: Links to or embeds a converted YAML file.

# @yaml
# ---
# title: Example YAML
# description: This is an example YAML block.
# ---

# @yaml_file path/to/example.yml

• 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:

  bundle exec yard

  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.

• In code object docstrings, prefer the tags above; they convert and render after the docstring via this plugin’s theme hook.
• In standalone Markdown pages, fenced ```yaml blocks render as code by Markdown; this plugin doesn’t auto‑convert them yet. Use either:
  • Link to an emitted page (after emission), e.g. [See config](./yaml/config.html).
  • Pre‑convert and paste HTML (Kramdown allows raw HTML):

    ruby -r yard/yaml -e 'print Yard::Yaml::Converter.from_string(File.read(ARGV[0]))[:html]' path/to/file.yml > tmp.html

    Then paste the HTML (optionally wrapped in <div class="yyaml-inline">…</div>).

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. Currently, Open Collective 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, Liberapay, PayPal, Open Collective and Tidelift.

Support us with a monthly donation and help us continue our activities. [Become a backer]

NOTE: kettle-readme-backers updates this list every day, automatically.

No backers yet. Be the first!

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]

NOTE: kettle-readme-backers updates this list every day, automatically.

No sponsors yet. Be the first!

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, 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: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags

See SECURITY.md.

If you need some ideas of where to help, you could work on adding more code coverage, or if it is already 💯 (see below) check issues or PRs, or use the gem and think about how it could be better.

We so if you make changes, remember to update it.

See CONTRIBUTING.md for more detailed instructions.

See CONTRIBUTING.md.

Everyone interacting with this project's codebases, issue trackers, chat rooms and mailing lists agrees to follow the .

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/galtzo-floss/yard-yaml/-/graphs/main

This library follows for its public API where practical. For most applications, prefer the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency("yard-yaml", "~> 0.0")

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:

• "Major Version Numbers are Not Sacred"

See CHANGELOG.md for a list of releases.

The gem is available as open source under the terms of the MIT .

See LICENSE.md for the official copyright notice.

• Copyright (c) 2025 Annibelle Boling
• Copyright (c) 2025-2026 Peter H. Boling

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.

To say "thanks!" ☝️ Join the Discord or 👇️ send money.

💌 💌 💌

Thanks for RTFM. ☺️