ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Table of Features

If you have any suggestions on our features, please submit feedback on our feature requests here. You can see what is planned and in progress.

* Denotes White Label Feature
^ Denotes Enterprise Feature


Admin Users

Add users who are able to use ReadMe’s platform to edit documentation.

Quickly find the docs you need through our search, which is powered by Algolia.

Swagger/OpenAPI Import

Build your API specifications using Swagger/OpenAPI and import them to have your reference docs auto-generated.


Update your documentation via API.

Make API calls directly from within the documentation, receive real information back, including error codes and header details.

User Connect*

Automatically login your users when they visit your docs via JWT

Custom Authentication^

Use your own OAuth to authenticate users.

Project Metrics^

See how your users are utilizing your docs.

Customize with CSS to make your site fit your brand. Use JS to built in extra features or customize your ReadMe page to make it easy to use.

Your site is at your own domain, for example or

Change the html settings in the footer and head to create extra links to change the style to fit your needs.

You can change the body color, theme, and logo.

A home page for your docs, can be fully customized.

Set your site to private using a site-wide password or ReadMe admin login

Subdomain Included

Your site will be


Set variables that you can re-use throughout your documentation.

Versions allow you to edit your documentation before making it live. They can be marked as beta or deprecated.

White Labeled

Remove the ReadMe logo and any mention of ReadMe from your site.

Support Forums

Include a community based forums for your API users to ask each other questions.

Announcements Page

Announce changes or create blog posts for your users.

Create a full-width custom page for marketing and any other purpose you may need.

Health Check*

Link your docs to StatusPage and inform your users about your current API status.


Define terms that may be specific to your API.


Keep your site secure with Let's Encrypt certs that are generated and maintained automatically.


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.