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

What's a Custom Page?

Custom Pages are not affected by versioning and are shared, so if you delete one keep in mind that it will be removed from other versions as well.

View this article as a Custom Page

Custom Pages are great when you want to retain the top navigation of your ReadMe project, but also want a custom look below the search bar.

What's different?

  1. No left sidebar navigation
  2. No table of contents on the right, even when headers are used
  3. Different URL path (subfolder is /page instead of /docs)

What's the same?

The top navigation is retained and the Page Title appears in the breadcrumb navigation.

Note

The Custom Page Title occupies the space of a Section in the breadcrumb navigation but it does not create a permanent Section in the drop-down menu.

Modes

Custom Pages have two modes:

  1. Markdown: The standard mode used in Documentation section
  1. HTML: The code is sanitized. If you want to include CSS or JavaScript, do so in Appearance > Custom Javascript/Stylesheet.

Full Page Width Option

The full page width option removes side margins of the standard regular width.

Full Page Width

Full Page Width

Regular Width

Regular Width


What's a Custom Page?


Suggested Edits are limited on API Reference Pages

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