Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
An effort to provide awesome documentation for the RubyGems ecosystem.
CSS HTML Ruby JavaScript
branch: gh-pages

Fetching latest commit…

Cannot retrieve the latest commit at this time

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 rubygems.org
images Remove unneccesary images
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 docs.rubygems.org at guides.rubygems.org"
MIT-LICENSE add some thanks and licenses
README.md 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
command-reference.md Add @luislavena's SSL certificate update guide
contributing.md contributing.md: mailing list -> google groups
credits.md Resolve conflicts from rebase
faqs.md Resolve conflicts from rebase
favicon.icns Fix favicon linking
favicon.ico Fix favicon linking
gems-with-extensions.md Updated location of extension.rdoc
index.md Resolve conflicts from rebase
make-your-own-gem.md add namespace in hola/translator example
name-your-gem.md simplify and resort name your gem example list
patterns.md Update patterns.md
plugins.md Fix the link to rbenv-gem-rehash
publishing.md Resolve conflicts from rebase
resources.md Resolve conflicts from rebase
rubygems-basics.md Resolve conflicts from rebase
rubygems-org-api.md add user id parameter to owner gems api response
run-your-own-gem-server.md Update run-your-own-gem-server.md
security.md Add @luislavena's SSL certificate update guide
specification-reference.md Rebuild for RubyGems 2.4.6
ssl-certificate-update.md Add @luislavena's SSL certificate update guide
what-is-a-gem.md Fixd old broken rubyforge rake links

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.

Something went wrong with that request. Please try again.