https://github.com/remino/gemdocs
Generate and view documentation for a Ruby gem
https://github.com/remino/gemdocs
docs documentation gem rdoc ruby rubydoc
Last synced: about 2 months ago
JSON representation
Generate and view documentation for a Ruby gem
- Host: GitHub
- URL: https://github.com/remino/gemdocs
- Owner: remino
- License: isc
- Created: 2025-04-14T12:46:38.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-14T12:53:11.000Z (about 1 year ago)
- Last Synced: 2025-04-17T22:07:19.859Z (about 1 year ago)
- Topics: docs, documentation, gem, rdoc, ruby, rubydoc
- Language: Shell
- Homepage:
- Size: 1.95 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# gemdocs
Generate and view documentation for a Ruby gem
By Rémino Rem
* [About](#about)
* [Usage](#usage)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
## About
Script for the post-popularity era of Ruby, for its crumbling ecosystem.
`gem server` no longer works. [RubyDoc.info](https://www.rubydoc.info) often
timeouts. Just run this script to generate documentation for a specific gem with
`rdoc` and start `httpd` to view it in a browser.
[Back to top](#gemdocs)
## Usage
Run `gemdocs` for details.
[Back to top](#gemdocs)
## Contributing
Contributions are what make the open source community such an amazing place to
learn, inspire, and create. Any contributions you make are **greatly
appreciated**.
If you have a suggestion that would make this better, please fork the repo and
create a pull request. You can also simply open an issue with the tag
"enhancement". Don't forget to give the project a star! Thanks again!
1. Fork the project
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a pull request
[Back to top](#gemdocs)
## License
Distributed under the ISC License. See `LICENSE.txt` for more information.
[Back to top](#gemdocs)
## Contact
Rémino Rem
[Back to top](#gemdocs)