Product Guide

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


Welcome to ReadMe

The Basics

ReadMe is an easy-to-use-tool to help you build out documentation! Each documentation site that you publish on ReadMe is a project. Within a project there is space for documentation, linking to your API, a blog, and many more features. Each of the projects within your account are published separately.

When you first create a new project, you will include your project name, subdomain, and logo. Our company mascot Owlbert will then guide you through the steps to launching your docs!

Adding Documentation

The first step to creating your new documentation is to add the categories that you want. There are two sections that you will be using, documentation for your general knowledge-base docs and reference docs for your API reference docs. Feel free to use one or both, whatever suits your needs.

All your documentation is written in GitHub flavored markdown and you can drag and drop widgets such as code samples and images on the right.

For your reference docs, you will first need to set up your API Settings, which can then be selected when you created your reference doc. You can label your reference docs with the different HTTP requests.

Customizing Appearance

After you have added your documentation, the next thing is to customize the appearance of your docs. You customize and add a landing page, which would be the first page that users see when they go to your site. In the appearance tab, you can edit the site colors, logo, and navigation links.

Managing your Project

Lastly, you can manage your project by enabling or disabling certain features, set up a custom domain, and manage your team.

Launching your project

You can preview your page by clicking on your project name on the top left. You will be required to login to preview it during trial. When your documentation is ready to go live, you can launch by going to upgrade plan tab and enter in your payment information.

Updated about a month ago


Welcome to ReadMe

Suggested Edits are limited on API Reference Pages

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