An effort to provide awesome documentation for the RubyGems ecosystem.
CSS HTML Ruby JavaScript
Latest commit e46209c Aug 8, 2016 @segiddins segiddins committed on GitHub Merge pull request #158 from ReidasaurusRex/typo-fix
Fixed pluarlity typo of 'inside a gems are' to 'inside gems are'
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
images Update DockYard sponsor logo in footer Jan 7, 2016
javascripts
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 9, 2013
MIT-LICENSE add some thanks and licenses Apr 27, 2011
README.md
Rakefile Update to non-deprecated arguments for `jekyll` Sep 14, 2013
_config.yml Switch to recommended markdown formatter Apr 18, 2014
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 8, 2015
credits.md Resolve conflicts from rebase Nov 3, 2014
faqs.md Resolve conflicts from rebase Nov 3, 2014
favicon.icns Fix favicon linking Nov 21, 2014
favicon.ico Fix favicon linking Nov 21, 2014
gems-with-extensions.md Updated location of extension.rdoc Jun 8, 2015
index.md Resolve conflicts from rebase Nov 3, 2014
make-your-own-gem.md
name-your-gem.md simplify and resort name your gem example list Dec 11, 2014
patterns.md
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
rubygems-basics.md Resolve conflicts from rebase Nov 3, 2014
rubygems-org-api.md
run-your-own-gem-server.md Update run-your-own-gem-server.md Apr 15, 2015
security.md
specification-reference.md Rebuild for RubyGems 2.6.5 Jun 22, 2016
ssl-certificate-update.md
what-is-a-gem.md Fixed pluarlity typo of 'inside a gems are' to 'inside gems are' Aug 7, 2016

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.