ReadMe

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

Manage Pages

You have a variety of ways to manage your pages as you edit them.

Preview Page

You can preview a page by clicking on the preview page icon next to the save button. It will open up the page in a new tab, and should work for public and unlisted pages.

Publish pages

Pages are unlisted by default until published, meaning they are not indexed by search engines and are not accessible without the link. When your doc is ready to be listed, simply click on the dropdown and publish it to make it live.

Unlist Pages

Unlisting a a published doc will be found in the dropdown next to the update doc button.

Caution

There is no confirmation box when unlisting pages. Changes will take effect immediately.

Change Page URL

Click the dropdown next to the save button, then choose change page slug to edit the page URL. Don't forget to Save.

Page Options

Hover over any page to reveal three options:

Hover over any page to see these icons.

Hover over any page to see these icons.

Add Subpage

The "+" icon will add subpage

The "+" icon will add subpage

Subpages are nest within the page that the icon was clicked on. To create a regular page, click the "+" icon from the Category name.

Subpages

The "+" icon is not available on subpages.

Clone Page

The duplicated page will be created directly below the original page.

The duplicated page will be created directly below the original page.

If the duplicate page is saved with the same Page Title, ReadMe will add a "-1" to the page URL.

Example:
Original Page URL: /docs/introduction
Duplicate Page URL: /docs/introduction-1

Delete Page

You must confirm that you want to delete the page, as it we cannot recover it if deleted.

Reorder Page

Drag a page to any other location, including other categories. Subpages will move with the page being dragged.

Caution

There is no confirmation box when reordering pages. Changes will take effect immediately.

Moving Categories between Documentation and Reference

There should be a button next to the category name that allows you to move categories between Documentation and Reference, as long as there are no API reference pages within the category.

Using the ReadMe Docs API

Using our API is a White Label feature!

You can also manage your docs using our Docs API, which allows you to return, update, delete, create and search documentation pages. This feature is found when adding a new page. When you see this prompt, click on "Want to create a doc with our API?" and it will guide you through the process.

If the option is not listed, it is likely because you are on a lower tier plan and would need to upgrade first.


Manage Pages


Suggested Edits are limited on API Reference Pages

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