Stop the JavaScript madness:
Write your docs with Ruby on Rails
Unleash the
Power of Rails
with HotDocs
..or read the Quickstart
HotDocs is a Rails engine that provides components & tools for writing docs
It's just Rails
Do you need the database? Or want to reuse code? What about Hotwire? Yes, yes, and yes! As a Rails dev, you'll feel at home.
Focus on the docs
HotDocs covers all your bases, you only need to author the content. Html and Markdown support included.
Static export
Export Html and Css for speed while allowing some elements to fetch fresh content from a backend.
Goals
- Lean on Rails so you don't have to catch up
- Defaults for 80% of your needs...
- ...escape hatches for 20% of your dreams
- Just one gem & one rake command
Anti-Goals
- Create new abstractions you have to learn
- Lock you in a new framework for life
- Require a complex setup and many dependencies
- Break features that Rails provides
Comparison with Jekyll & Docusaurus
| 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 | β | β | β |
| Anything missing? Suggestions? Contribute | |||
