An effort to provide awesome documentation for the RubyGems ecosystem.
CSS HTML Ruby JavaScript
Failed to load latest commit information.
_layouts Add @luislavena's SSL certificate update guide Feb 27, 2015
_plugins Replace old C extensions page with redirect Aug 6, 2013
fonts More styles from rubygems.org Nov 5, 2014
images Update DockYard sponsor logo in footer Jan 7, 2016
javascripts Fix assets Nov 3, 2014
rdoc/generator/template/jekdoc Fix favicon linking Nov 21, 2014
stylesheets Add fastly as a sponsor Dec 18, 2014
.gitignore Ignore files from my_malloc branch Aug 6, 2013
.travis.yml Fix Travis CI build. Nov 21, 2014
CC-LICENSE add some thanks and licenses Apr 27, 2011
CNAME Revert "Point docs.rubygems.org at guides.rubygems.org" Sep 8, 2013
MIT-LICENSE add some thanks and licenses Apr 27, 2011
README.md Update readme for new jekyll version Oct 10, 2014
Rakefile Update to non-deprecated arguments for `jekyll` Sep 13, 2013
_config.yml
command-reference.erb Resolve conflicts from rebase Nov 3, 2014
command-reference.md Rebuild for RubyGems 2.6.6 Jun 22, 2016
contributing.md Add @arthurnn to contributing page Oct 7, 2015
credits.md
faqs.md
favicon.icns Fix favicon linking Nov 21, 2014
favicon.ico Fix favicon linking Nov 21, 2014
gems-with-extensions.md
index.md Resolve conflicts from rebase Nov 3, 2014
make-your-own-gem.md Remove deprecated info Feb 17, 2016
name-your-gem.md simplify and resort name your gem example list Dec 11, 2014
patterns.md Update patterns.md Mar 17, 2015
plugins.md gem-compare moved to fedora-ruby, redirect to new url Jan 14, 2016
publishing.md Correct the anchor name for the gem-owner command Sep 7, 2015
resources.md Added Libraries.io to Monitoring resources Feb 26, 2016
rubygems-basics.md
rubygems-org-api.md
run-your-own-gem-server.md Update run-your-own-gem-server.md Apr 15, 2015
security.md Remove link to OSVDB on /security and update some URLs Jun 10, 2016
specification-reference.md Rebuild for RubyGems 2.6.5 Jun 21, 2016
ssl-certificate-update.md
what-is-a-gem.md Fixd old broken rubyforge rake links Feb 15, 2015

README.md

RubyGems Guides

An effort to provide awesome documentation for the RubyGems ecosystem.

Goals

  • 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 docs.rubygems.org
  • Port content from rubygems.org/pages/docs
  • Port content from help.rubygems.org knowledge base
  • Find lots of StackOverflow/ruby-talk questions and get their common answers in here
  • Fill out more guides!

Setup

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 (command-reference.md), 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

Thanks

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

Legal

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