ReadMe.io

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 there is a feature that you want and it is not on our roadmap, please submit a Feature Request.

Feature
Description

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.

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

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 docs.yoursite.com or devs.yourcompany.com.

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 yoursite.readme.io.

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.

Features