Ruby Documentation

Open-source Ruby projects categorized as Documentation
Edit details
Topics: Ruby Rails HacktoberFest documentation-tool Markdown
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com
Sponsored

Top 23 Ruby Documentation Projects

  • devdocs

    API Documentation Browser

    • Project mention: Every Dunder Method in Python | news.ycombinator.com | 2024-04-03

    > I've started to preface all python searches with 'site:python.org'

    You might find DevDocs to be useful: https://devdocs.io/

  • Gollum

    A simple, Git-powered wiki with a local frontend and support for many kinds of markup and content.

    • Project mention: Can Git or any other VCS be used as a database instead of SQL/NoSQL ones? Have you ever seen such a thing? | /r/AskProgramming | 2023-12-07

    Arguably something like ikiwiki or gollum is doing this. These are both wikis that use git as their backend 'database'. I happen to like wikis like this a lot better over wikis that store their data in mysql or some other traditional SQL backend.

  • WorkOS

    The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

    WorkOS logo

  • jazzy

    Soulful docs for Swift & Objective-C

  • GitHub Changelog Generator

    Automatically generate change log from your tags, issues, labels and pull requests on GitHub.

  • 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.

    • Project mention: I don't always use LaTeX, but when I do, I compile to HTML (2013) | news.ycombinator.com | 2024-01-25

    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/ ).

  • Annotate

    Annotate Rails classes with schema and routes info

    • Project mention: Must-have gems for mature Rails | dev.to | 2024-02-02

    gem "annotate" - https://github.com/ctran/annotate_models | Adds DB-schema comments to models. May be unnecessary on RubyMine, YMMW.

  • Apipie

    Ruby on Rails API documentation tool

  • InfluxDB

    Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

    InfluxDB logo

  • Hologram

    A markdown based documentation system for style guides.

  • YARD

    YARD is a Ruby Documentation tool. The Y stands for "Yay!"

    • Project mention: What is JSDoc and why you may not need typescript for your next project? | dev.to | 2024-01-22

    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..

  • jsduck

    Simple JavaScript Duckumentation generator.

  • rspec_api_documentation

    Automatically generate API documentation from RSpec

  • Ronn

    the opposite of roff

    • Project mention: Kramdown-man: A Kramdown convert for converting Markdown files into man pages | news.ycombinator.com | 2023-12-03

  • grape-swagger

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

  • RDoc

    RDoc produces HTML and online documentation for Ruby projects.

    • Project mention: Xeme: I'd value your opinion on my new Ruby gem | /r/ruby | 2023-05-29

    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.

  • bluedoc

    An open-source document management tool for enterprise self host.

  • Inch

    A documentation analysis tool for the Ruby language

  • fab-manager

    Fab-Manager is the FabLab management solution. It provides a comprehensive, web-based, open-source tool to simplify your administrative tasks and your marker's projects.

  • rubychanges

    Comprehensive changelog of Ruby Programming Language

    • Project mention: Question about the language (beginner) | /r/ruby | 2023-05-08

    If you want to know what Ruby changes, a good reference is Ruby changes

  • allourideas.org

    allourideas allows groups to collect and priorize information in an open, democratic, and efficient process.

  • diaspora_federation

    A library that provides functionalities needed for the diaspora* federation protocol.

  • Apidoco

    Ruby on Rails API documentation tool

  • ansible-doc-generator

    CLI for documenting Ansible roles into Markdown files.

  • Hanna

    RDoc generator designed with simplicity, beauty and ease of browsing in mind

  • SaaSHub

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

    SaaSHub logo
NOTE: The open source projects on this list are ordered by number of github stars. The number of mentions indicates repo mentiontions in the last 12 Months or since we started tracking (Dec 2020).

Ruby Documentation related posts

Index

What are some of the best open-source Documentation projects in Ruby? This list will help you:

Project Stars
1 devdocs 33,858
2 Gollum 13,559
3 jazzy 7,318
4 GitHub Changelog Generator 7,299
5 Asciidoctor 4,641
6 Annotate 4,327
7 Apipie 2,448
8 Hologram 2,157
9 YARD 1,905
10 jsduck 1,499
11 rspec_api_documentation 1,439
12 Ronn 1,347
13 grape-swagger 1,078
14 RDoc 819
15 bluedoc 623
16 Inch 519
17 fab-manager 218
18 rubychanges 190
19 allourideas.org 156
20 diaspora_federation 99
21 Apidoco 72
22 ansible-doc-generator 38
23 Hanna 37

Sponsored
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com