# `breadcrumbs`

Use the `breadcrumbs` option to control the links displayed at the top of the page to indicate a page's location in the navigation structure.

The breadcrumbs option also supports page-level configuration using front matter.

![Screenshot of page in project with breadcrumbs](/assets/breadcrumbs.f453afe234e2a2ca9c76ba01d6a05d0647b146e560af1e765eefedeaa58597cc.d96f5373.png)

Breadcrumbs are enabled by default, but can be disabled to remove them from your published project.
You can also add links that you want to always appear on every page at the start of the breadcrumbs links.

## Options

| Option | Type | Description |
|  --- | --- | --- |
| hide | boolean | Disables breadcrumb links in the project when set to `true`.
Default value: `false` |
| prefixItems | [[Breadcrumb object](#breadcrumb-object)] | A list of breadcrumb links to always be displayed first. |


### Breadcrumb object

| Option | Type | Description |
|  --- | --- | --- |
| page | string | **REQUIRED.** Path to the file which represents the page to link to.
If you do not include the `label` property, the text for the link will match the level 1 heading of the page. |
| label | string | Link text displayed for the item. |
| labelTranslationKey | string | Translation key used for [localization](/docs/realm/config/l10n). |


## Example


```yaml
breadcrumbs:
  hide: false
  prefixItems:
    - page: index.page.tsx
      label: Home
      labelTranslationKey: home.title
```

## Related options

- Customize other default items on Markdown pages, such as the last updated time stamp and the page headings table of contents on the left side of the page, using the [`markdown` configuration options](/docs/realm/config/markdown).
- Remove or update the label text for the previous and next navigation buttons using the [`navigation` configuration options](/docs/realm/config/navigation).


## Resources

- **[Navigation concepts](/docs/realm/navigation/navigation)** - Understand different navigation elements in your project including breadcrumbs and their role in user experience
- **[Configure navigation elements](/docs/realm/navigation)** - Customize navigation elements including sidebar, navbar, footer, and breadcrumbs for optimal site organization
- **[Front matter configuration](/docs/realm/config/front-matter-config)** - Configure breadcrumb behavior and appearance on individual pages using front matter for granular control
- **[Configuration options](/docs/realm/config)** - Explore other project configuration options for comprehensive documentation and platform customization