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 built into Markdoc while others are Redocly-specific. We use badges to indicate a tag's availability:

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

Example admonition element:

Cards Redocly Custom Tag

Use cards to help users navigate your documentation by grouping information and links in a pre-built UI card. Choose from several pre-defined styles and formats.

Additional information and syntax: Cards tag

Example cards element:

Code Snippet Redocly Custom Tag

Use the Code Snippet tag to render a code sample from an external file in a configurable code block element.

Additional information and syntax: Code Snippet tag

Example code snippet element:

    - group: Markdoc Tag Library
      page: learn/markdoc/tags/tag-library.md
      items:
      - separator: Built-in tags
      - page: learn/markdoc/tags/partial.md
        label: Partial
      - page: learn/markdoc/tags/table.md
        label: Table
      - separator: Redocly Tags
      - page: learn/markdoc/tags/admonition.md
        label: Admonition
      - page: learn/markdoc/tags/cards.md
        label: Cards
      - page: learn/markdoc/tags/code-snippet.md
        label: Code Snippet
      - page: learn/markdoc/tags/inline-svg.md
        label: Inline SVG
      - page: learn/markdoc/tags/json-schema.md
        label: JSON Schema

Inline SVG Redocly Custom Tag

Use the inline SVG tag to render an SVG element inline with your writing.

Additional information and syntax: Inline SVG tag

Example inline SVG element:

This tag is so cool it's scary .

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

Example JSON schema element:

OpenAPI Code Sample Redocly Custom Tag

Use the OpenAPI Code sample tag to render a code sample for an API operation from an OpenAPI description.

Additional information and syntax: OpenAPI Code Sample tag

curl -i -X DELETE \
  -u custom-username:custom-password \
  https://redocly.com/_mock/demo/openapi/museum-api/special-events/dad4bce8-f5cb-4078-a211-995864315e39

{
  "type": "object",
  "title": "Validation failed"
}

Partial Built-in Markdoc Tag

Use the Partial tag to render the content from another file.

Additional information and syntax: Partial tag

Example partial element:

Replay OpenAPI Redocly Custom Tag

Allow users to send live calls to your API using the Replay OpenAPI tag.

Additional information and syntax: Replay OpenAPI tag

Example element:

Table Built-in Markdoc Tag

Use the Table tag to create tables using a list-based syntax that allows for easy injection of rich content, like bulleted lists and code samples.

Additional information and syntax: Table tag

Example table element:

Tabs Redocly Custom Tag

Use the tabs tag to organize content into a series of tabs that users can switch between.

Additional information and syntax: Tabs tag