Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

An effort to provide awesome documentation for the RubyGems ecosystem.

branch: gh-pages
Octocat-spinner-32 _includes make it bigger May 17, 2011
Octocat-spinner-32 _layouts Add RubyGems Basics page August 12, 2013
Octocat-spinner-32 _plugins Replace old C extensions page with redirect August 06, 2013
Octocat-spinner-32 images get this guides party started April 27, 2011
Octocat-spinner-32 rdoc Include method arguments in documentation January 22, 2014
Octocat-spinner-32 stylesheets fix avatar display on contributing page October 18, 2013
Octocat-spinner-32 .gitignore Ignore files from my_malloc branch August 06, 2013
Octocat-spinner-32 .travis.yml Enable travis for guides October 25, 2013
Octocat-spinner-32 CC-LICENSE add some thanks and licenses April 27, 2011
Octocat-spinner-32 CNAME Revert "Point docs.rubygems.org at guides.rubygems.org" September 08, 2013
Octocat-spinner-32 MIT-LICENSE add some thanks and licenses April 27, 2011
Octocat-spinner-32 README.md Update jekyll instructions and config file June 25, 2013
Octocat-spinner-32 Rakefile Update to non-deprecated arguments for `jekyll` September 13, 2013
Octocat-spinner-32 _config.yml Enable travis for guides October 25, 2013
Octocat-spinner-32 command-reference.erb Fix link order to match index August 15, 2013
Octocat-spinner-32 command-reference.md Rebuild for RubyGems 2.2.2 February 05, 2014
Octocat-spinner-32 contributing.md fix avatar display on contributing page October 18, 2013
Octocat-spinner-32 credits.md Update Github repo and user urls from HTTP -> HTTPS September 30, 2013
Octocat-spinner-32 faqs.md Add note on rubygems-trust to FAQs page February 03, 2013
Octocat-spinner-32 favicon.ico get this guides party started April 27, 2011
Octocat-spinner-32 gems-with-extensions.md Merge pull request #59 from francisgo/patch-3 October 10, 2013
Octocat-spinner-32 index.md Create basic security page, move content from publishing November 19, 2013
Octocat-spinner-32 make-your-own-gem.md Corrected the documentation for Rdoc March 29, 2014
Octocat-spinner-32 name-your-gem.md Extract link hrefs with references February 15, 2014
Octocat-spinner-32 patterns.md Document a pre and regular version dependency January 22, 2014
Octocat-spinner-32 plugins.md Add gem-patch to the list of plugins October 09, 2013
Octocat-spinner-32 publishing.md Fix broken link to security guide December 08, 2013
Octocat-spinner-32 resources.md Add link guide of how to cryptographically sign your RubyGem November 12, 2013
Octocat-spinner-32 rubygems-basics.md Add table of contents to Rubygems Basics August 13, 2013
Octocat-spinner-32 rubygems-org-api.md remove download stats endpoints December 30, 2013
Octocat-spinner-32 run-your-own-gem-server.md Update geminabox link December 07, 2013
Octocat-spinner-32 security.md Don't link to rubygems-openpgp-ca.org April 15, 2014
Octocat-spinner-32 specification-reference.md Document required_rubygems_version= in specification guide. February 23, 2014
Octocat-spinner-32 what-is-a-gem.md Add RubyGems Basics page August 12, 2013
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 -w

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.

Something went wrong with that request. Please try again.