This is the first blog post I have written for the gem, so I will start with the short version:

yard-fence is a Ruby gem that helps YARD generate cleaner documentation from Markdown files that contain braces.

If you have ever had README examples, inline code, or template placeholders like {issuer} or {{TOKEN}} cause noisy YARD InvalidLink warnings, yard-fence exists for that problem.

The problem

YARD is great at generating Ruby API documentation, and it can include Markdown content like a README in the generated docs. The trouble starts when Markdown content contains brace-heavy examples.