yard-fence 0.9.0: cleaner YARD docs when Markdown braces get in the way
The yard-fence 0.9.0 release introduces improvements for generating cleaner documentation with YARD when using Markdown files that contain braces. This Ruby gem addresses the issue of InvalidLink warnings caused by brace-heavy examples in documentation. The update emphasizes a Rake-driven approach for documentation processing, enhancing the overall workflow for users.
- ▪Yard-fence is a Ruby gem designed to help YARD generate cleaner documentation from Markdown files with braces.
- ▪The 0.9.0 update introduces explicit Rake-driven documentation processing, improving the integration with YARD tasks.
- ▪The gem temporarily replaces ASCII braces with fullwidth braces during the documentation build to avoid InvalidLink warnings.
Opening excerpt (first ~120 words) tap to expand
try { if(localStorage) { let currentUser = localStorage.getItem('current_user'); if (currentUser) { currentUser = JSON.parse(currentUser); if (currentUser.id === 561326) { document.getElementById('article-show-container').classList.add('current-user-is-article-author'); } } } } catch (e) { console.error(e); } Peter H. Boling Posted on May 24 yard-fence 0.9.0: cleaner YARD docs when Markdown braces get in the way #ruby #rubygems #yard #opensource 🤺 yard-fence 0.9.0 is out. 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.
…
Excerpt limited to ~120 words for fair-use compliance. The full article is at DEV.to (Top).
Discussion
0 commentsMore from DEV.to (Top)
