Last updated

Markdoc variables

Markdoc variables allow you to access dynamic data in your Markdoc content. This reference documents the available variables and their usage.

Available variables

VariableDescription
$rbac.teamsArray of RBAC teams the user belongs to
$user.emailUser's email address
$user.authCookieUser's authentication cookie
$user.{claim}Other user claims from the Identity Provider (IdP)
$idpAccessTokenUser's access token
$langCurrent page locale ID from the config or default_locale if i18n is not configured
$frontmatter.{property}Access properties defined in the page's front matter
$env.{name}Access environment variables

Usage examples

You can use these variables within your Markdoc content:

Welcome, !

Data structure examples

$rbac

{
  "teams": [
    "sample",
    "authenticated"
  ]
}

$user

The structure of $user depends on your Identity Provider (IdP). Here's an example:

{
  "at_hash": "0194_mIut36l1RvlemrfUA",
  "aud": ["41e74d64-6b6b-44b5-8779-28df7aa3cce6"],
  "auth_time": 1747025292,
  "email": "smile@example.com",
  "exp": 1747032494,
  "firstName": "Smile",
  "https://redocly.com/auth/aud": [
    "redocly"
  ],
  "https://redocly.com/sso/teams": [
    "sample",
    "authenticated"
  ],
  "iat": 1747025293,
  "id": "usr_00h4e3haae4mtb50gtn497n93d",
  "iss": "https://auth.cloud.redocly.com/oidc",
  "jti": "74a7518b-e05e-417f-9931-94b523237212",
  "lastName": "Example",
  "loginSource": "sso",
  "providerId": "idp_01h4dygdnk9veyr4wzkkf9824m",
  "rat": 1747025291,
  "sessionId": "a6bbb5cb-4fc5-40e1-901a-9d104264f708",
  "sid": "a6bbb5cb-4fc5-40e1-901a-9d104264f708",
  "sub": "idp_01h4dygdnk9veyr4wzkkf9978m__smile@example.com",
  "idpId": "oidc",
  "teams": [
    "sample",
    "authenticated"
  ],
  "name": "smile@example.com",
  "authCookie": "[auth cookie value]"
}

$idpAccessToken

"ory_at_CcByTgsW7q......"

$lang

"default_locale"

$frontmatter

Access properties defined in the front matter of the current page:

example.md
---
title: Getting Started
description: Learn how to use our product
author: Redocly Team
---

# {% $frontmatter.title %}

By {% $frontmatter.author %}

$env

Access environment variables that have been exposed to the Markdoc renderer.

Usage example: {% $env.PUBLIC_REDOCLY_BRANCH_NAME %}

 
Next page