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


Define words in the context of your product

The GlossaryGlossary - A feature in Readme that allows you to define words in the context of your product. Just type "<<" in our editor and all the terms that you defined under General Settings > Glossary will be available! Note: Markdown does not work in the Glossary. allows you to define word or phrase and then display that definition as a pop uppop up - You have to have explicitly use a glossary term by typing "<<" in the ReadMe editor. The glossary feature will not find and replace all words that match your glossary term. wherever that word or phrase is used in Readme.

1. Create Glossary Item

Go to the new Glossary Tab and create a Glossary Item by adding your term and the definition.

2. Add it to Your Docs

Type << in the editor search through all of the glossary words you’ve created.

3. Delight Your End User

The definition pops up when you hover over the underlined term


Glossary terms do not appear on a standalone page

ReadMe does not generate a dedicated glossary page from the terms you enter in the project's dash. Instead, glossary terms will only display in the markdown editor or as popups when the user hovers over the word.

Updated about a month ago


Define words in the context of your product

Suggested Edits are limited on API Reference Pages

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