An effort to provide awesome documentation for the RubyGems ecosystem.
An effort to provide awesome documentation for the RubyGems ecosystem.
If a guide is empty, start filling it out! Or, make a new one! Pull requests are gladly accepted!
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.erband run:
$ rake command_guide
For the Specification Guide, the documentation comes directly from the
Gem::Specificationclass in RubyGems. Edit it, set your
RUBYGEMS_DIRto where your code directory is, and run:
$ RUBYGEMS_DIR=~/Dev/ruby/rubygems rake spec_guide --trace
Huge thanks to thoughtbot whose playbook 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.