HotDocs: Write your docs with Ruby on Rails
Let's stop the JavaScript madness:
HotDocs is a set of optimized Rails components & tools for writing docs:
- Write your docs from scratch (with the starter-kit)
- Embed docs in your Rails app (with the components)
Comparison
| Feature | HotDocs | Jekyll | Docusaurus |
|---|---|---|---|
| Ruby on Rails (database, Hotwire, etc.) | ✅ | ❌ | ❌ |
| Embed docs in an existing Rails app | ✅ | ❌ | ❌ |
| Standalone docs | ✅ | ✅ | ✅ |
| Styled components you can customize | ✅ | ✅ | ✅ |
| Markdown (with syntax highlight & themes) | 🚀 | 👍 | 🚀 |
| Static export | 🔜 🚀 | 👍 | 🚀 |
| Search | 🔜 ✅ | 🔌 | 🔌 |
| Light / Dark | 🔜 ✅ | 🔌 | ✅ |
| Open source | ✅ | ✅ | ✅ |
| Free (if you keep the "Built with HotDocs" in the footer) | ✅ | ✅ | ✅ |
Anything missing? Suggestions? See how to contribute below.
Demo
HotDocs uses itself for its docs: check the demo out.
Development
In its current state, HotDocs is a Rails app. Run it with:
bin/setupContributing
Let's create a Rails alternative to (just) Ruby and JavaScript docs frameworks:
- Chime in the discussions with your feedback and wishes
- Open an issue
- Submit a pull request