Last updated

Markdoc Tag Library

This page contains a comprehensive list of Markdoc tags with links to deeper resources where you can see how to use them. Some tags are Markdoc-native while others are Redocly-specific. We use badges to indicate a tag's availability:

BadgeMeaning
Redocly Custom Tag Tags built into Redocly products and available for customers to use in their projects.
Native Markdoc Tag Tags built into Markdoc's core that are available to all Markdoc users.

Admonition Redocly Custom Tag

Use the Admonition Tag to highlight important information. Choose from multiple pre-defined types like info, warning, and success.

Additional information and syntax: Admonition Tag

Read this thing!

This tag is useful for drawing attention.


Details Redocly Custom Tag

Use the Details Tag to hide content behind an expandable element.

Additional information and syntax: Details Tag

Click me to show content...

This feature is called progressive disclosure.


JSON Schema Redocly Custom Tag

Use the JSON Schema Tag to render an existing or inline schema in a configurable, readable layout.

Additional information and syntax: JSON Schema Tag

name
string (EventName)

Name of the special event

location
string (EventLocation)

Location where the special event is held

eventDescription
string (EventDescription)

Description of the special event

dates
Array of strings <date> (EventDates)

List of planned dates for the special event

price
number <float> (EventPrice)

Price of a ticket for the special event