https://github.com/rubydocs/app

Fancy docs for any Ruby project
https://github.com/rubydocs/app

docs docs-generator documentation documentation-generator documentation-site documentation-tool rails ruby rubydocs

Last synced: about 1 month ago
JSON representation

Fancy docs for any Ruby project

• Host: GitHub
• URL: https://github.com/rubydocs/app
• Owner: rubydocs
• License: mit
• Created: 2014-05-18T15:40:23.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2024-04-02T08:22:29.000Z (9 months ago)
• Last Synced: 2024-05-28T12:51:34.360Z (7 months ago)
• Topics: docs, docs-generator, documentation, documentation-generator, documentation-site, documentation-tool, rails, ruby, rubydocs
• Language: Ruby
• Homepage: https://rubydocs.org
• Size: 722 KB
• Stars: 51
• Watchers: 5
• Forks: 9
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

• Open-Source-Ruby-and-Rails-Apps - rubydocs - Fancy docs for any Ruby project (Happy Exploring 🤘)

README

        
# RubyDocs

RubyDocs lets you create fast and searchable docs for any Ruby project by using the [sdoc](https://github.com/zzak/sdoc) documentation tool.

The application is live at https://rubydocs.org/

If you find a bug or have an idea for a new feature, please [open an issue](https://github.com/manuelmeurer/rubydocs/issues/new)!

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request

## Support

If you find RubyDocs useful and would like to support the ongoing development, [buy me a coffee](https://www.buymeacoffee.com/279lcDtbF) or [become a sponsor](https://github.com/sponsors/manuelmeurer)!

## License

This project is licensed under the MIT License - see the LICENSE.txt file for details.