🍲 Yard::Fence

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.

A brace converter for the markdown fences in your YARD docs to prevent the InvalidLink warning.

Just the important bits:

• Preprocesses top-level README and other .md/.txt files into tmp/yard-fence/ replacing ASCII braces inside fenced code blocks, inline code spans, and simple placeholders like {issuer} or {{TOKEN}} with visually identical fullwidth braces.
• This prevents YARD from emitting InvalidLink warnings.
• Prioritizes Kramdown's GFM parser so tables and fenced code blocks render correctly.
• After YARD finishes generating HTML, restores fullwidth braces back to normal ASCII braces so code examples are copy‑pastable.
• The supported workflow is rake yard; raw yard / bin/yard does not run the explicit prepare + postprocess hooks.

Create a .yardopts file like this:

--plugin fence
-e yard/fence/hoist.rb
--readme tmp/yard-fence/README.md
--charset utf-8
--markup markdown
--markup-provider kramdown
--output docs
'lib/**/*.rb'
-
'tmp/yard-fence/*.md'
'tmp/yard-fence/*.txt'

See the configuration and usage sections for more details.

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.

Federated DVCS Repository	Status	Issues	PRs	Wiki	CI	Discussions
🧪 galtzo-floss/yard-fence on GitLab	The Truth	💚	💚	💚	🐭 Tiny Matrix	➖
🧊 galtzo-floss/yard-fence on CodeBerg	An Ethical Mirror (Donate)	💚	💚	➖	⭕️ No Matrix	➖
🐙 galtzo-floss/yard-fence 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-fence

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

gem install yard-fence

Yard::Fence writes sanitized copies of top-level Markdown/TXT into tmp/yard-fence/ during the rake-based YARD workflow. To avoid YARD parsing the unsanitized originals, point YARD at the tmp/yard-fence/ copies.

Recommended .yardopts (noise-free) for the rake-based workflow:

--plugin fence
-e yard/fence/hoist.rb
--readme tmp/yard-fence/README.md
--charset utf-8
--markup markdown
--markup-provider kramdown
--output docs
'lib/**/*.rb'
-
'tmp/yard-fence/*.md'
'tmp/yard-fence/*.txt'

Why tmp/yard-fence/?

• The plugin converts ASCII { } to fullwidth ｛ ｝ only in tmp/yard-fence/ so YARD won't treat brace content as reference tags and emit InvalidLink warnings. After docs are generated, the HTML is restored back to normal ASCII braces for easy copy/paste.

When markdown files are removed from your project, their corresponding HTML files may remain in docs/. To ensure a clean build:

# Option 1: Use the YARD_FENCE_CLEAN_DOCS environment variable
YARD_FENCE_CLEAN_DOCS=true bundle exec rake yard

# Option 2: Manually clear the docs directory before running yard
rm -rf docs/ && bundle exec rake yard

The tmp/yard-fence/ staging directory is always cleared automatically before regeneration to prevent stale preprocessed files.

Use the rake integration, not raw yard, so the prepare + postprocess steps run around the YARD build:

require "yard"
require "yard/fence"

YARD::Rake::YardocTask.new(:yard) { |t| t.files = [] }
Yard::Fence.install_rake_tasks!(:yard)

Then build docs with:

bundle exec rake yard

If your project exposes bin/yard, treat it the same as raw yard: it runs YARD itself, but it does not run Yard::Fence.install_rake_tasks!(:yard). Use bundle exec rake yard whenever tmp/yard-fence/ staging is part of the setup.

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-fence/-/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-fence", "~> 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-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. ☺️