rdoc-markdown
RDoc to Markdown generator (by skatkov)
rubydoc.info
Next generation rdoc.info site (by docmeta)
rdoc-markdown | rubydoc.info | |
---|---|---|
4 | 6 | |
24 | 132 | |
- | 0.0% | |
5.1 | 5.3 | |
7 months ago | 8 months ago | |
Ruby | Ruby | |
GNU General Public License v3.0 only | 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.
rdoc-markdown
Posts with mentions or reviews of rdoc-markdown.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2022-10-25.
-
rdoc-markdown is close to stable!
I already shared this gem called rdoc-markdown, but I've received a lot of awesome feedback and spent time improving this even further.
-
rdoc-markdown gem
I filed it in an issue https://github.com/skatkov/rdoc-markdown/issues/26
-
POSH TUI: week 4 progress update.
Gem is already open-sourced at github/skatkov/rdoc-markdown. It currently generates readable documentation in Markdown, but there are still some quirks in rendering I stumble upon.
rubydoc.info
Posts with mentions or reviews of rubydoc.info.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-07-07.
-
What's the Difference Between `ruby-doc.org` and `docs.ruby-lang.org`?
Yes, I use rubydoc.info to refer to the docs for gems, didn't realize until now that it also includes documentation for Ruby itself. Thanks!
-
Xeme: I'd value your opinion on my new Ruby gem
GitHub will render markdown (and other formats), but I don't believe it supports parsing and rendering YARD or RDoc. Both tools ship with tools that generate documentation websites that you can use for your project. YARD also has https://rubydoc.info
-
Is anybody aware that rubydoc.info is down?
Right now, gemdocs.org is very similar to rubydoc.info as it both uses YARD, with rubydoc.info supporting custom YARD plugins for gems (which might make some gem output look better if they specify said plugins). I have some ideas for improving Ruby documentation in general, so I've been trying to not add too much functionality to YARD as I might be trying to pivot back to RDoc.
-
What's the skinny re: rubydoc.info?
The experiment is: can I pre-generate and store the docs forever? Everyone is probably going to say sure, stick them on S3 and forget about it. But how does that get funded? Who is going to pay for that? rubydoc.info is hosted via sponsorship.
-
What's up with rubydoc.info?
rubydoc.info is supported by one person and is open-source. Care to report the problems here: https://github.com/docmeta/rubydoc.info ?
What are some alternatives?
When comparing rdoc-markdown and rubydoc.info you can also consider the following projects:
YARD - YARD is a Ruby Documentation tool. The Y stands for "Yay!"
chunky_png - Read/write access to PNG images in pure Ruby.
feeds - Collection of Dash docset feeds
sord - Convert YARD docs to Sorbet RBI and Ruby 3/Steep RBS files
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
devdocs - API Documentation Browser
RDoc - RDoc produces HTML and online documentation for Ruby projects.
rubocop - A Ruby static code analyzer and formatter, based on the community Ruby style guide.
zeal - Offline documentation browser inspired by Dash
xeme - Xeme - general purpose format for reporting results.