ALPHA RUBY DOC
A CLI Gem That Scrapes Ruby Documentation
THE ULTIMATE RUBY DEVELOPER REFERENCING TOOL!
Alpha Ruby Doc aims to make Ruby referencing quick and painless. This gem scrapes Ruby documentation and allows developers to quickly search or browse full documentation for classes, modules and/or methods. Including syntax examples, source Code, and even source links.
Features include Search by Name, Paginated Browsing, Full documentation including Syntax and Source Code, Save to Favorites (persists), Source Links, Seamless Navigation, and more.
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
Features:
✓ Search for Ruby Documentation by Class, Module or Method Name
✓ Full documentation including description, syntax and source code!
✓ Save Docs to Favorites! for quick referencing (Persists)
✓ Browse all Documentation (Paginated Output To Terminal)
✓ Source Links Provided
✓ Easy Navigation
✓ Random Dev Quotes (For fun and motivation)
To do list:
- Multiple Doc sources
- Add Notes
INSTALLATION
JUST KIDDING
For Your Application:
Add this line to your application's Gemfile
gem 'ruby_doc'
And then execute
$ bundle
For Yourself:
$ gem install ruby_doc
And then execute
$ bundle
USAGE
Once installed execute
$ ruby_doc
To exit
$ exit!
To Learn More (From Main Menu)
$ ?
To List Favorites (From Main Menu)
$ *
To Reset Favorites (From Favorites Menu)
$ reset!
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.