Skip to content
An effort to provide awesome documentation for the RubyGems ecosystem.
CSS HTML Ruby JavaScript
Find file
Failed to load latest commit information.
_layouts Add @luislavena's SSL certificate update guide
_plugins Replace old C extensions page with redirect
fonts More styles from
images Update DockYard sponsor logo in footer
javascripts Fix assets
rdoc/generator/template/jekdoc Fix favicon linking
stylesheets Add fastly as a sponsor
.gitignore Ignore files from my_malloc branch
.travis.yml Fix Travis CI build.
CC-LICENSE add some thanks and licenses
CNAME Revert "Point at"
MIT-LICENSE add some thanks and licenses Update readme for new jekyll version
Rakefile Update to non-deprecated arguments for `jekyll`
_config.yml Switch to recommended markdown formatter
command-reference.erb Resolve conflicts from rebase Rebuild for RubyGems 2.5.2 Add @arthurnn to contributing page Resolve conflicts from rebase Resolve conflicts from rebase
favicon.icns Fix favicon linking
favicon.ico Fix favicon linking Updated location of extension.rdoc Resolve conflicts from rebase add namespace in hola/translator example simplify and resort name your gem example list Update gem-compare moved to fedora-ruby, redirect to new url Correct the anchor name for the gem-owner command Merge pull request #146 from SuriyaaKudoIsc/patch-3 Resolve conflicts from rebase Updated outdated links to gemcutter Update Update process for reporting a security vulnerability in a gem Rebuild for RubyGems 2.5.1 Add @luislavena's SSL certificate update guide Fixd old broken rubyforge rake links

RubyGems Guides

An effort to provide awesome documentation for the RubyGems ecosystem.


  • Be the definitive place for RubyGems knowledge
  • Help out those new to RubyGems get started and get things done
  • Make it easy to contribute more guides

Want to help?

If a guide is empty, start filling it out! Or, make a new one! Pull requests are gladly accepted!

  • Port content from
  • Port content from
  • Port content from knowledge base
  • Find lots of StackOverflow/ruby-talk questions and get their common answers in here
  • Fill out more guides!


Make sure you have jekyll installed (gem install jekyll), and run:

$ jekyll serve

The pages will be available at http://localhost:4000/

Every guide except for the Command and Specification Reference is just a straight up markdown page, so just go edit it!

For the Command Guide (, edit command-reference.erb and run:

$ rake command_guide

For the Specification Guide, the documentation comes directly from the Gem::Specification class in RubyGems. Edit it, set your RUBYGEMS_DIR to where your code directory is, and run:

$ RUBYGEMS_DIR=~/Dev/ruby/rubygems rake spec_guide --trace


Huge thanks to thoughtbot whose handbook this is based off of.


The actual content of the articles is licensed under Creative Commons. The code that this project consists of is licensed under MIT.

Something went wrong with that request. Please try again.