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

Quick Switcher

The fastest way to navigate ReadMe

Keyboard Shortcuts

Mac: +K
Windows: Ctrl+K

The Quick Switcher allows you to search for and jump directly to:

  • Pages (from Guides, API Reference, Custom Pages or Changelog posts)
  • Settings (any sidebar menu item in both Enterprise groups and regular projects)
  • Projects (other ReadMe projects that you have access to)

from anywhere inside ReadMe.

To open Quick Switcher, use +K for Mac, Ctrl+K for Windows, or click on the magnifying glass at the bottom of the sidebar menu.

Legacy Projects

If you don't see the Quick Switcher, you are on a legacy ReadMe project. Reach out to [email protected] and we can walk you through a free upgrade to Hub 2!


Quick Switcher


The fastest way to navigate ReadMe

Suggested Edits are limited on API Reference Pages

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