YARD Alternatives
Similar projects and alternatives to YARD
-
-
-
-
-
Asciidoctor
:gem: A fast, open source text processor and publishing toolchain, written in Ruby, for converting AsciiDoc content to HTML 5, DocBook 5, and other formats.
-
GitHub Changelog Generator
Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
-
-
-
Scout APM
Scout APM: A developer's best friend. Try free for 14-days. Scout APM uses tracing logic that ties bottlenecks to source code so you know the exact line of code causing performance issues and can get back to building a great product faster.
-
rspec_api_documentation
Automatically generate API documentation from RSpec
-
motor-admin-rails
Low-code Admin panel and Business intelligence Rails engine. No DSL - configurable from the UI.
-
-
-
-
-
just-the-docs
A modern, high customizable, responsive Jekyll theme for documention with built-in search.
-
pages-gem
A simple Ruby Gem to bootstrap dependencies for setting up and maintaining a local Jekyll environment in sync with GitHub Pages
-
vale
:pencil: A syntax-aware linter for prose built with speed and extensibility in mind.
-
-
project-bot
:octocat: Automatically add and move Issues/Pull Requests on a Project board (by philschatz)
-
-
vale-action
:octocat: The official GitHub Action for Vale -- install, manage, and run Vale with ease.
Reviews and mentions
-
ActiveAdmin, I'm looking at you
DSLs don't have to be horrible, just document them with YARD. Document the methods and what they take, yield, and return. Provide @example tags and put top-level examples for how to use classes/modules, and copy/paste the best examples into the README.
-
How does Ruby feel for someone with a staticaly typed background (Scala)
Coming from C, C++, Java, I found Ruby classes to be a lot like Java classes but without the additional formality. The OOP paradigm is still there (everything is an object in Ruby), but there's no abstract keyword or interfaces or virtual friend methods (although there's modules and protected methods). Ruby is duck-typed, so a lot of the time you just have to trust that the right type of data is given to you (although you can still do explicit type checking with obj.kind_of?(Foo) and raise an ArgumentError or TypeError). In order to remember what types a method should receive, I document them using YARDoc (similar to JavaDoc but for Ruby). If you want Ruby syntax/stdlib and a more traditional Static Typed experience, checkout Crystal which provides both Type Inference and Strong Typing.
-
Building a Documentation Workflow in Rails
More complex documentation can be created using RDoc or other syntax (see the YARD documentation), but we'll stick with the existing documentation here.
-
Static Typing in Ruby 3 Gives Me a Headache (But I Could Grow to Like It)
Right now, I'm in the middle of an extensive overhaul of the Bridgetown project to add YARD documentation comments to all classes and methods. With the Solargraph gem + VSCode plugin installed, I get extensive type descriptions and code completion with a minimal amount of effort. If I were to type:
Stats
lsegal/yard is an open source project licensed under MIT License which is an OSI approved license.
Popular Comparisons
Are you hiring? Post a new remote job listing for free.