With the new dynamic documentation server in YARD 0.6, you can now see exactly what YARD sees as you document your code. Simply type yard server, reload to have your project watch for changes in your codebase everytime you refresh the page. With this functionality, you almost have no excuse not to write documentation! You can write all kinds of extensions in YARD, including ones that can understand all of the dynamic magic your framework does in its own little Domain Specific Languages (DSLs). Most importantly, it's really easy to do! There are already plugins that support frameworks like RSpec, DataMapper, Sinatra, and support for others are in the works. YARD is the only Ruby documentation tool that supports storing metadata alongside your documentation. This metadata can be used to create consistent documentation in any format you wish. YARD also comes with a powerful templating system to quickly modify existing templates.

Features

  • Preview As You Document
  • Support Your Own DSL
  • Easily Customize Templates
  • Extend, Extend, Extend!
  • YARD is also designed for extensibility everywhere else
  • Plugins can also add commands to the yard executable to provide extra functionality

Project Samples

Project Activity

See All Activity >

Categories

Documentation

License

MIT License

Follow YARD

YARD Web Site

Other Useful Business Software
99.99% Uptime for MySQL and PostgreSQL on Google Cloud Icon
99.99% Uptime for MySQL and PostgreSQL on Google Cloud

Enterprise Plus edition delivers sub-second maintenance downtime and 2x read/write performance. Built for critical apps.

Cloud SQL Enterprise Plus gives you a 99.99% availability SLA with near-zero downtime maintenance—typically under 10 seconds. Get 2x better read/write performance, intelligent data caching, and 35 days of point-in-time recovery. Supports MySQL, PostgreSQL, and SQL Server with built-in vector search for gen AI apps. New customers get $300 in free credit.
Try Cloud SQL Free
Rate This Project
Login To Rate This Project

User Reviews

Be the first to post a review of YARD!

Additional Project Details

Programming Language

Ruby

Related Categories

Ruby Documentation Software

Registered

2022-09-07