> Agent-readable docs index: /llms.txt. Download /docs.zip to grep all markdown files locally.

---
"$schema": https://holocron.so/frontmatter.json
title: Pages and Frontmatter
description: How MDX pages, slugs, and metadata work in Holocron.
icon: file-text
---

# Pages and Frontmatter

Every page in a Holocron site is an **MDX file** (`.mdx` or `.md`). Pages are discovered through the navigation config in `docs.jsonc`, not by filesystem convention.

<Aside>
  <Note>
    Only pages listed in `docs.jsonc` navigation appear in the sidebar. Creating an MDX file alone is not enough.
  </Note>
</Aside>

## Page slugs

The slug is the file path relative to `pagesDir` (e.g. `src/`), without the extension:

| File path             | Slug          | URL            |
| --------------------- | ------------- | -------------- |
| `src/index.mdx`       | `index`       | `/`            |
| `src/quickstart.mdx`  | `quickstart`  | `/quickstart`  |
| `src/guides/auth.mdx` | `guides/auth` | `/guides/auth` |

Reference these slugs in your `docs.jsonc`:

```jsonc
{
  "navigation": [
    {
      "group": "Guides",
      "pages": ["quickstart", "guides/auth"]
    }
  ]
}
```

## Frontmatter

Every page can have YAML frontmatter at the top of the file:

```mdx
---
title: Authentication
description: How to set up auth in your app.
icon: lock
sidebarTitle: Auth
tag: New
---
```

### Supported fields

| Field            | Type    | Description                                   |
| ---------------- | ------- | --------------------------------------------- |
| `title`          | string  | Page title, used in sidebar and `<title>` tag |
| `description`    | string  | SEO description and subtitle                  |
| `icon`           | string  | Icon displayed next to the page in sidebar    |
| `sidebarTitle`   | string  | Override the title shown in sidebar           |
| `tag`            | string  | Badge label next to the title in sidebar      |
| `hidden`         | boolean | Hides the page from navigation                |
| `noindex`        | boolean | Prevents search engines from indexing         |
| `og:title`       | string  | Open Graph title override                     |
| `og:description` | string  | Open Graph description                        |
| `og:image`       | string  | Open Graph image URL                          |

## MDX basics

MDX lets you use JSX components alongside standard Markdown:

```mdx
# My Page

Regular **Markdown** works as expected.

<Note>
And you can use components like callouts, cards, and tabs.
</Note>
```

Holocron provides all the standard Mintlify components out of the box. See the [Components](/components) page for the full list.

## The index page

The page with slug `index` renders at `/`. Every other slug maps directly to a URL path.


---

*Powered by [holocron.so](https://holocron.so)*