ReadMe Documentation

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. There, you can also see what is planned and in progress.

To see a chart of features and plans, check out our pricing page.

Feature

Description

Admin Users

Add users who are able to use ReadMeā€™s platform to edit documentation.

Search

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

Swagger/OpenAPI Import

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

API

Update your documentation via ReadMe's API.

API Explorer

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

User Connect

Automatically log in your users when they visit your docs via JWT.

Custom Authentication

Use your own OAuth to authenticate users.

Documentation Metrics

See how your users are utilizing your docs.

Custom CSS and JavaScript

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

Set up Custom Domain & SSL

Your site is at your own domain, for example docs.yoursite.com or devs.yourcompany.com.

Custom HTML in Footer/Header

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

Theme Editor

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

Landing Page

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

Private Internal Documentation

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

Subdomain Included

Your site will be yoursite.readme.io.

Variables

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

Versions

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 forum for your API users to ask each other questions.

Announcements Page

Announce changes or create blog posts for your users.

Custom Pages

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.

Glossary

Define terms that may be specific to your API.

SSL

Keep your site secure with Cloudflare certificates that are generated and maintained automatically.

Updated 28 days ago


Features


Suggested Edits are limited on API Reference Pages

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