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

Theme Editor

In the theme editor tab you can add your logo and choose between a basic white header theme or a custom colored header with various styles.

Color Logo

This is where you upload your logo. Generally a transparent logo will work best.

The the optimal logo size is 150 x 250px. Acceptable file formats are PNG, JPG, JPEG. GIFs are not supported.

White Logo

The white logo is used for backgrounds in the dark theme.


The third option you have is to upload a favicon.

Basic Header

With the basic header, you can change the color of the header's bottom border and the color of the link in your landing page.

Custom Header

You have the option of customizing the header more in this section, such as changing the background color or using a custom image.

Header Style

With the custom header, you can select from four types of styles including a custom image as well as the background color.


Your normal logo might not look as good in a colored header, so you can use your white logo and enable it here.


Here you'll be able to change the color of the links in the landing page.

Updated about a month ago

Theme Editor

Suggested Edits are limited on API Reference Pages

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