Using Glossary

Define words in the context of your product

The Glossary allows you to define word or phrase and then display that definition as a pop up wherever that word or phrase is used in Readme.


Glossary term limitations

Adding Glossary terms with special characters won't render! We recommend just adding Glossary terms with letters or numbers.

  1. Create Glossary Item

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

  1. Add it to Your Docs

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

  1. 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.