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

Site Navigation

URL Structure

The URL structure of your site will be subdomain/docs/page-slug. Only the subdomain and the page-slug can be changed. The docs and reference paths cannot be changed.

Top Navigation

Left and Right Side Nav

In this section you can add links to different parts of your documentations as well as external links.

Logo Link

The default link for the logo will be your landing page, but you can also set it to your homepage URL from your project settings.


First Page

In this drop down you can select the first page that is shown when your users visit the site.

Section Names

The section names such Documentation can be changed here and it will propagate throughout your entire instance.

Show Version?

Checking this will have the version number included in your breadcrumb links. Turn this off if you would like to hide the version number.

Hide Table of Contents

Checking this will hide the automatically-generated table of contents.

Updated about a year ago

Site Navigation

Suggested Edits are limited on API Reference Pages

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