Documentation

Create and manage beautiful, interactive documentation the easy way.


const request = require("request");

const options = {
  method: 'POST',
  url: 'https://hoot.at/api/hoot',
  headers: {
    authorization: 'Basic cmVhZG1lOg=='
    'content-type': 'application/json'
  },
  body: { post: 'Hello World!'},
  json: true,
};

request(options, (error, response, body) => {
  if (error) throw new Error(error);

  console.log(body);
});
Documentation Tailored to Users

Include API keys directly in the docs, auto-generate code samples, and easily make real API calls.

Build a Community

Answer questions in the support forum, keep everyone up to date on changes, and allow users to suggest edits.

Easy to Update Within Seconds

Sync your Swagger file, update content in our editor, or merge a suggested edit to make sure docs are always up to date.

Create and Launch Quickly

Drag-and-drop your way to beautiful docs, landing pages, and more, or go totally custom with your own CSS. It's all instantly searchable.

People Love:
  • Markdown Editor
  • Theme Builder
  • Swagger File Import

Build Interactive Reference Guides

Allow your users to craft their API calls in our playground then copy and paste the resulting real code samples with their API keys.

People Love:
  • Dynamic Code Snippets
  • Interactive API Playground
  • API Definitions
  • API Logs

Have a Swagger/OAS 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.

Collaborate with ease

ReadMe is easy to use for everyone from your writers to your sales team. Users and team members can suggest edits, with versioning to keep things clean.

People Love:
  • Suggest Edits
  • Versioning
  • Internal & Private Docs

Give Awesome Customer Support

Collect and act on customer feedback with forum-style support. From feature requests to product Q&A, connecting with customers has never been easier.

People Love:
  • Support Forums
  • Feature Requests
  • Changelogs

Want to create interactive documentation?

Then sign up for ReadMe now!
Get Started Now