YARD

YARD is a Ruby Documentation tool. The Y stands for "Yay!" (by lsegal)

YARD Alternatives

Similar projects and alternatives to YARD

  1. starter-workflows

    306 YARD VS starter-workflows

    Accelerating new GitHub Actions workflows

  2. InfluxDB

    InfluxDB – Built for High-Performance Time Series Workloads. InfluxDB 3 OSS is now GA. Transform, enrich, and act on time series data directly in the database. Automate critical tasks and eliminate the need to move data externally. Download now.

    InfluxDB logo
  3. crystal

    247 YARD VS crystal

    The Crystal Programming Language

  4. forem

    206 YARD VS forem

    For empowering community 🌱

  5. parcel

    185 YARD VS parcel

    The zero configuration build tool for the web. 📦🚀

  6. swc

    159 YARD VS swc

    Rust-based platform for the Web

  7. turbo

    156 YARD VS turbo

    The speed of a single-page web application without having to write any JavaScript (by hotwired)

  8. lsp-mode

    119 YARD VS lsp-mode

    Emacs client/library for the Language Server Protocol

  9. Stream

    Stream - Scalable APIs for Chat, Feeds, Moderation, & Video. Stream helps developers build engaging apps that scale to millions with performant and flexible Chat, Feeds, Moderation, and Video APIs and SDKs powered by a global edge network and enterprise-grade infrastructure.

    Stream logo
  10. loki

    89 YARD VS loki

    Like Prometheus, but for logs.

  11. JSDoc

    73 YARD VS JSDoc

    An API documentation generator for JavaScript.

  12. eglot

    68 YARD VS eglot

    A client for Language Server Protocol servers

  13. Bridgetown

    35 YARD VS Bridgetown

    A next-generation progressive site generator & fullstack framework, powered by Ruby

  14. Hanami

    23 YARD VS Hanami

    A flexible framework for maintainable Ruby apps

  15. RDoc

    10 YARD VS RDoc

    RDoc produces HTML and online documentation for Ruby projects.

  16. Middleman

    15 YARD VS Middleman

    Hand-crafted frontend development

  17. motor-admin-rails

    Low-code Admin panel and Business intelligence Rails engine. No DSL - configurable from the UI. Rails Admin, Active Admin, Blazer modern alternative.

  18. Rails Erd

    10 YARD VS Rails Erd

    Generate Entity-Relationship Diagrams for Rails applications

  19. steep

    9 YARD VS steep

    Static type checker for Ruby

  20. grape-swagger

    Add OAPI/swagger v2.0 compliant documentation to your grape API

  21. sord

    8 YARD VS sord

    Convert YARD docs to Sorbet RBI and Ruby 3/Steep RBS files

  22. Annotate

    9 YARD VS Annotate

    Annotate Rails classes with schema and routes info

  23. SaaSHub

    SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives

    SaaSHub logo
NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a better YARD alternative or higher similarity.

YARD discussion

Log in or Post with

YARD reviews and mentions

Posts with mentions or reviews of YARD. We have used some of these posts to build our list of alternatives and similar projects. The last one was on 2024-01-22.
  • What is JSDoc and why you may not need typescript for your next project?
    8 projects | dev.to | 22 Jan 2024
    JSDOC is a predefined method of documenting code for javascript ecosystem created in 1999 that works similar to libraries for other languages such as: Javadoc for java, YARD for ruby, etc..
  • Xeme: I'd value your opinion on my new Ruby gem
    5 projects | /r/ruby | 29 May 2023
    In addition to project documentation, you've included a lot of code comments. You could adopt a standardized format and use it to generate API documentation. RDoc and YARD are two options. If I were reviewing this code at work, I would probably ask you to remove comments that explain what, not why.
  • Programming types and mindsets
    4 projects | /r/ruby | 8 May 2023
    I still just document everything using YARD and focus on designing really obvious Object Models and of course write tests. I have tried using sord to convert my YARD type annotations to RBS or RBI, but you still have to fill in missing bits, then use steep and somehow load in RBS/RBI files for other gems and stdlib, and it's just an uphill battle since Ruby is dynamically typed by default. Obviously Dynamic Typing lends itself more to Dynamic Languages, where you can call an arbitrary method and let the language VM figure it out at runtime. Static or Strong Typing lends itself better to compiled languages where everything needs to be resolved at compile time and converted into object code. If I need to work in a compiled language, then I'll use Crystal, which also supports type inference. TypeScript's type syntax is quite nice, but I tend to avoid writing massive JavaScript code bases where a Type Checker helps catch subtle bugs, and instead prefer sticking to minimal amounts of vanilla JavaScriot in order to keep complexity low and not overwhelm the browser.
  • kwargs and YARD: @param or @option?
    1 project | /r/ruby | 11 Apr 2023
    I had a dig into the file history, and it looks like we have to go back to 0.7 to find the old tag list. Here we find the info we need to understand the intent of the @option tag:
  • Comparing RDoc, YARD, and SDoc: Choosing the Right Documentation Generator for Your Ruby on Rails 5 Project
    1 project | dev.to | 20 Jan 2023
    YARD: http://yardoc.org/
  • How do you document your code?
    3 projects | /r/rails | 17 Jan 2023
    I tend to follow along using the YardDoc comment style. It has many small things I love about it; an example is when yardoc is followed it can be used to generate RBS/Sorbet type files with the sord gem, you can also generate application documents similar to rdoc/sdoc.
  • The right is on the left
    3 projects | /r/technicallythetruth | 13 Jan 2023
    That turns out to be a pretty common use case for markdown. Github, for example, renders your README.md is part of a git repo's "home" page. It's also common to have tooling that parses specially formatted comments in your source code and produce a documentation bundle, usually as a web page (ex. RDoc, YARD, JSDoc, etc.).
  • #buildinpublic, issue 1: building API documentation browser for command line
    2 projects | dev.to | 15 Oct 2022
    My first assumption was, that I should be able to generate markdown from the source. Same ruby and rails does now, but only tweaking a couple of parameters to generate .md files instead. YARD is being used for that and it supports any markup rdoc or yard.
  • The Why and How of Yardoc
    6 projects | dev.to | 17 Mar 2022
    I’ve long used the YARD format and chose to use that as my documentation syntax. I suppose I didn’t check with anyone on this decision and slowly started adding documentation. I want to use this post to synthesize my implicit decision and the benefits of using Yard as the documentation format.
  • Graphic representation of class / module inheritance in Rails?
    2 projects | /r/rails | 26 Feb 2022
    That said, YARD is a ruby documentation tool that has a yard graph command you can use to dump a UML graph for your app into a .dot file, which can be used with lots of different graphing tools (usually graphviz but there are a bunch of online tools and open source projects that can visualize them for you).
  • A note from our sponsor - SaaSHub
    www.saashub.com | 9 Jul 2025
    SaaSHub helps you find the best software and product alternatives Learn more →

Stats

Basic YARD repo stats
18
1,976
7.4
about 2 months ago

lsegal/yard is an open source project licensed under MIT License which is an OSI approved license.

The primary programming language of YARD is Ruby.


Sponsored
InfluxDB – Built for High-Performance Time Series Workloads
InfluxDB 3 OSS is now GA. Transform, enrich, and act on time series data directly in the database. Automate critical tasks and eliminate the need to move data externally. Download now.
www.influxdata.com