Ruby Documentation

Open-source Ruby projects categorized as Documentation

Top 21 Ruby Documentation Projects

  • GitHub repo devdocs

    API Documentation Browser

    Project mention: PWA's I use Daily as a Web Developer. | dev.to | 2021-04-12

    5) DevDocs - DevDocs combines multiple API documentations in a fast, organized, and searchable interface.

  • GitHub repo jazzy

    Soulful docs for Swift & Objective-C

  • GitHub repo GitHub Changelog Generator

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

  • GitHub repo Annotate

    Annotate Rails classes with schema and routes info

  • GitHub repo 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: Question about writing software | reddit.com/r/linuxquestions | 2021-03-08
  • GitHub repo Apipie

    Ruby on Rails API documentation tool

  • GitHub repo Hologram

    A markdown based documentation system for style guides.

  • GitHub repo YARD

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

    Project mention: Static Typing in Ruby 3 Gives Me a Headache (But I Could Grow to Like It) | dev.to | 2021-03-01

    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:

  • GitHub repo jsduck

    Simple JavaScript Duckumentation generator.

    Project mention: HTML5 Resource | dev.to | 2021-02-24

    Sencha Touch tutorials

  • GitHub repo rspec_api_documentation

    Automatically generate API documentation from RSpec

  • GitHub repo Ronn

    the opposite of roff

  • GitHub repo grape-swagger

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

  • GitHub repo Aruba

    Test command-line applications with Cucumber-Ruby, RSpec or Minitest. The most up to date documentation can be found on Cucumber.Pro (https://app.cucumber.pro/projects/aruba)

  • GitHub repo RDoc

    RDoc produces HTML and online documentation for Ruby projects.

    Project mention: Building Jekyll-Twitch, the gem | dev.to | 2021-04-01

    RDoc We'll use this gem to document our TwitchTag.rb class.

  • GitHub repo Inch

    A documentation analysis tool for the Ruby language

  • GitHub repo Documentation

    A Rails engine to provide the ability to add documentation to a Rails application (by adamcooke)

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

    Project mention: FabLab inventory management software | reddit.com/r/FabLab | 2021-03-06

    You can try Fab Manager https://github.com/sleede/fab-manager its a web app based on Ruby on Rails / AngularJS.

  • GitHub repo allourideas.org

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

    Project mention: Community Big Board | reddit.com/r/NFL_Draft | 2021-03-09

    www.allourideas.org

  • GitHub repo Apidoco

    Ruby on Rails API documentation tool

  • GitHub repo Hanna

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

  • GitHub repo ansible-doc-generator

    CLI for documenting Ansible roles into Markdown files.

    Project mention: Ansible Playbook Documentation | reddit.com/r/ansible | 2021-01-10

    BTW we ended up creating a small tool that allows us to create special comments in the roles and then extract them in a markdown https://github.com/PopulateTools/ansible-doc-generator

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). The latest post mention was on 2021-04-12.

Index

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

Project Stars
1 devdocs 25,419
2 jazzy 6,869
3 GitHub Changelog Generator 6,398
4 Annotate 3,695
5 Asciidoctor 3,598
6 Apipie 2,216
7 Hologram 2,175
8 YARD 1,667
9 jsduck 1,514
10 rspec_api_documentation 1,371
11 Ronn 1,237
12 grape-swagger 1,001
13 Aruba 902
14 RDoc 642
15 Inch 506
16 Documentation 215
17 fab-manager 147
18 allourideas.org 146
19 Apidoco 66
20 Hanna 26
21 ansible-doc-generator 0