Say Goodbye to Static Documentation

Show, Don't Tell

With interactive documentation, your users can play around with your API right in the docs. Once they've crafted the perfect code snippet, they can copy it in their language of choice!

PathBodyQueryHeader
POSThttps://hootr.co/api/hoot/category
  • 200 Results
Run this example to see the results

Have a Swagger file?

If you already have a Swagger / OpenAPI Spec file, setting up your docs is easy! Just give us your file, and we'll create documentation out of it. Learn more

Examples

Documentation

Depending on your settings and tweaks, your documentation will look something like this. By default, users would get to this page by clicking Documentation. However, you can easily make this your main page if you want your users to jump right in.

2 minute setup
documentation plan
Preview this Example

Default Theme

When you first set up your develop hub on ReadMe, we build you a basic site using the colors from your logo. If you're on the free plan, this is what your hub will look like. If you're on a paid plan, you can tweak the colors, fonts and styles for this theme.

0 minute setup
free plan
Preview this Example

Solid Header

This is the second most simple theme you can go with. Your background doesn't have to be solid — the theme builder lets you choose between colors, images, gradients and more. With just a few clicks, you can have a hub that looks great and fits your brand.

2 minute setup
documentation plan
Preview this Example

Three Columns

Ever since Stripe created the three column layout for their documentation, it's been all the rage. With just one click, you can turn on this layout for your documentation. It's optimized for API documentation with endpoints, however it works for anything.

3 minute setup
documentation plan
Preview this Example

Custom CSS

Looking to stand out? The startup plan lets you modify the CSS, and the business plan lets you add JavaScript and edit some of the HTML. With just a little bit of work, your developer hub can perfectly match whatever look your site is going for.

30 minute setup
developer hub plan
Preview this Example

ReadMe has made our lives infinitely easier. We've had it on our todo list for over a year, and a day after finding ReadMe we had our docs launched. We're super impressed. Y'all have built a f!#&ing awesome tool.

Collaboration

Crowdsource your docs! Users can keep docs current by suggesting changes.

API Explorer

Let users play with your API right inside the documentation.

Changelogs

Keep everyone up to date with what's going on via announcements.

Editor

Markdown-based drag-and-drop editor makes documentation almost fun.

Theme Builder

Easily create a beautiful dev community that matches your brand.

Support

Let users ask questions and request features in the support forums.

Versioning

Maintaining old or testing beta versions of your docs is a breeze!

Internal Docs

ReadMe isn't just for public docs! It's easy to set up internal documentation.

Pricing

Let us help find the right plan for you:

Developer Hub
59
Monthly | Per Project
  • Customizable landing page
  • Custom CSS
  • 5 documentation versions
  • 10 admin users
  • Use your own domain
  • Interactive API Explorer
  • Auto-generated API Browser
  • Private Internal Docs
Get Started
White Label
199
Monthly | Per Project
  • Unlimited users and versions
  • Completely white-labeled
  • Custom Javascript
  • Custom HTML in footers & head
  • Custom 404 URL redirection rules
Get Started
Enterprise
Monthly
  • Priority Phone Support
  • Custom SLA / Terms of Service
  • Additional Feature Requests
  • Vendor security forms
  • Custom Invoicing Options
  • User management (OAuth2, Okta, etc)
  • Documentation Migration services
Contact Us
All plans have a 14-day free trial before launch.
No credit cards until your site is ready to go!Get Started