ReadMe Markdown

And more...

Additional Markdown features of the ReadMe platform implementation.

We've also built a lot of great features right in to the ReadMe app, which work on top of our markdown engine to give your developers a best-in-class documentation experience. These features aren't all baked in to the new engine itself, but they're worth mentioning nonetheless!

Sectioning Semantics

Data Replacement

User Variables

If you've set up JWT logins and user variables in your ReadMe project, you can use the double angle-bracket notation for variable expansions. So if you're logged in to and have a name variable set, then this...

Hi, my name is **<<name>>**!

...should expand to this: “Hi, my name is Generic User!”

Glossary Terms

Did you know you can define various technical terms for your ReadMe project? Using our glossary feature, these terms can be used anywhere in your Markdown! Just use the same double angle-bracket syntax you would for user variables with a “glossary:” prefix before the term, like so:

Both **<<glossary:exogenous>>** and **<<glossary:endogenous>>** are long words.

Which expands to: “Both exogenousexogenous - Relating to or developing from external factors. and endogenousendogenous - Having an internal cause or origin. are long words.”

Emoji Shortcodes

You can use GitHub-style emoji short codes (feat. Owlbert!)

:sparkles: :owlbert-reading:

This expands out to: “:sparkles: :owlbert-reading:

Updated 2 months ago


And more...


Additional Markdown features of the ReadMe platform implementation.

Suggested Edits are limited on API Reference Pages

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