For AI agents: the documentation index is at /docs/llms.txt. Append .md to any page URL, or send Accept: text/markdown, for the Markdown version of that page.
For AI agents: the documentation index is at llms.txt. Markdown versions are available by appending .md to any page URL, including this page's markdown.
Reference every YAML frontmatter field for Edda pages, including title, description, sidebarTitle, icon, and SEO options with examples.
Every MDX page starts with YAML frontmatter between --- delimiters. The title field is required. All other fields are optional.
Published with Edda
icon | string | Icon displayed next to the page title in the sidebar. | Yes | — |
iconType | "regular" | "solid" | "light" | "thin" | "sharp-solid" | "duotone" | "brands" | Icon style variant. | Yes | — |
mode | "default" | "wide" | "custom" | "frame" | "center" | Page layout mode. | Yes | "default" |
hidden | boolean | Hide this page from navigation. The page is still accessible via direct URL. | Yes | false |
deprecated | boolean | Mark the page as deprecated. Displays a deprecation badge. | Yes | false |
noindex | boolean | Prevent search engines from indexing this page. | Yes | false |
keywords | string[] | Additional keywords for search indexing. | Yes | — |
tag | string | Display a tag badge next to the page title. | Yes | — |
url | string | Override the navigation link to point to an external URL. | Yes | — |
hideApiMarker | boolean | Hide the API method badge on OpenAPI pages. | Yes | — |
hideFooterPagination | boolean | Hide the previous/next navigation at the bottom of the page. | Yes | — |
---
title: Authentication
description: Learn how to authenticate API requests.
icon: lock
tag: Updated
mode: wide
---