YARD
YARD is a Ruby Documentation tool. The Y stands for "Yay!" (by lsegal)
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. (by asciidoctor)
Our great sponsors
YARD | Asciidoctor | |
---|---|---|
18 | 34 | |
1,904 | 4,613 | |
- | 1.8% | |
6.9 | 8.9 | |
1 day ago | 3 days ago | |
Ruby | Ruby | |
MIT License | MIT License |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
YARD
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?
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
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
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.
-
How do you document your code?
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
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
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
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?
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).
-
What is your development setup (IDE, gems, library, ci/cd etc) for RoR/non-RoR applications development ?
Linux (Fedora), gvim (because it opens a new window instead of taking up yet-another-terminal-tab), fluxbox (because it has awesomely configurable hot-key support), dotfiles, chruby + ruby-install (with rubies installed into /opt/rubies), bundler + rspec + yard + rubygems-tasks + gemspec_yml + GitHub Actions on all of my Ruby projects.
-
Best services and/or gems for automated generation of documentation, unit tests, and useful things of this nature
If you're looking to generate docs from source, there's always the yard gem. If you want a diagram of your Rails models you might try railroady. Neither will create comments in your code, which is what I understand mintlify.com is doing for you.
Asciidoctor
Posts with mentions or reviews of Asciidoctor.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2024-01-25.
-
I don't always use LaTeX, but when I do, I compile to HTML (2013)
You have also AsciiDoctor ( https://asciidoctor.org/ ) which is alive and well. I am using it for technical CS documentation internally, but only for single page documents. I did not try to deploy their whole multi-document setup called Antora ( https://antora.org/ ).
-
[DEV][App Release] Markor 2.11 adds AsciiDoc and CSV Support
AsciiDoc File support. ( #1876, #808, #2022)
-
Documentation generators and custom syntax highlighting
I use Asciidoctor, highlightjs, a custom highlight.js language definition and that bash script:
-
I wish Asciidoc was more popular
AsciiDoc is so close to being good. It slam dunks Markdown, but they just have a few nagging issues that they refuse to fix, for 9 years now:
In fact, also this claim is wrong, because there are three :D
-
Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code
Asciidoctor is a Ruby-based text processor for parsing AsciiDoc into a document model and converting it to HTML5, PDF, EPUB3, and other formats. Built-in converters for HTML5, DocBook5, and man pages are available in Asciidoctor. Asciidoctor has an out-of-the-box default stylesheet and built-in integrations for MathJax (display beautiful math in your browser), highlight.js, Rouge, and Pygments (syntax highlighting), as well as Font Awesome (for icons). Although Asciidoctor is written in Ruby, that does not mean you need to know Ruby to use it. Asciidoctor can be executed on a JVM using AsciidoctorJ or in any JavaScript environment (including the browser) using Asciidoctor.js. You can choose any one of three Asciidoctor processors (Ruby, JavaScript, Java/JVM) and get the same experience. You can also use the Asciidoctor Maven Plugin to convert your Asciidoc documentation using Asciidoctor from an Apache Maven build.
-
Designing Go Libraries: The Talk: The Article
asciidoctor for writing
-
Docs as code vs a tool that can work with .md and xml?
If you're looking at AsciiDoc, you'll want to look at Asciidoctor: https://asciidoctor.org/
- Diving deeper into custom PDF and ePub generation
-
Mau: a lightweight markup language based on Jinja
The third system that I found was AsciiDoc, which started as a Python project, abandoned for a while and eventually resurrected by Dan Allen with Asciidoctor. AsciiDoc has a lot of features and I consider it superior to Markdown, but Asciidoctor is a Ruby program, and this made it difficult for me to use it. In addition, the standard output of Asciidoctor is a nice single HTML page but again customising it is a pain. I eventually created the site of the book using it, but adding my Google Analytics code and a sitemap.xml to the HTML wasn't trivial, not to mention customising the look of elements such as admonitions.
What are some alternatives?
When comparing YARD and Asciidoctor you can also consider the following projects:
RDoc - RDoc produces HTML and online documentation for Ruby projects.
Apipie - Ruby on Rails API documentation tool
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
Zettlr - Your One-Stop Publication Workbench
plantuml - Generate diagrams from textual description
ansible-doc-generator - CLI for documenting Ansible roles into Markdown files.
hugo-PaperMod - A fast, clean, responsive Hugo theme.
pandoc - Universal markup converter
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
wavedrom - :ocean: Digital timing diagram rendering engine