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

We have implemented a more powerful search using Algolia to help your users find the articles they are searching for even faster.

You can find the search in the fixed navigation bar:

As you type, the entire project is searched, with the search term underlined. Users can also filter the query down to specific sections to get more accurate results.

Search can also be opened by pressing cmd/ctrl+k and navigated using nothing but the keyboard!

Enterprise Global Search

If you have several projects unified under an Enterprise Group, search will work across all the projects under that domain. Users will also be able to search only specific projects to limit the results that are returned.

Updated 3 months ago


Suggested Edits are limited on API Reference Pages

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