ALPHA RUBY DOC

Gem Version Gem Changelog GitHub last commit

A CLI Gem That Scrapes Ruby Documentation

image

Ever get tired of leaving your editor / environment to google a method, or more in depth info on a class or module? This gem aims to make Ruby referencing quick and more importantly, LOCAL!

Alpha Ruby Doc scrapes Ruby documentation and allows users to quickly reference Ruby methods and additional information all on your terminal. Have a query? Run, Hunt, and Done. Never lose momentum, keep all things in your line of sight, and get right back to coding!

A Look Inside

forthebadge

image

Features:

✓ Search for Ruby Documentation by Class, Module or Method Name

✓ Browse all Documentation (Paginated Output To Terminal)

✓ View Descriptions and Syntax

✓ View Source Code

✓ Source Links Provided

✓ Easy Navigation

✓ Random Dev Quotes (For fun and motivation)

Coming Soon:

  • Multiple Doc sources
  • Save Favorites
  • Add Notes

INSTALLATION

image

JUST KIDDING

forthebadge

For Your Application:

Add this line to your application's Gemfile

gem 'ruby_doc'

And then execute

$ bundle

For Yourself:

$ gem install ruby_doc

USAGE

Once installed execute

$ ruby_doc

To exit 

$ exit!

To Learn More 

$ ?

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/AlphaDaniel/alpha-ruby_doc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the AlphaRefRuby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.