Skip to main content
OwnDocs

Breadcrumbs

1 min readStableBeginner

OwnDocs generates breadcrumb navigation from the page's file path. It gives readers an at-a-glance sense of where they are in the documentation hierarchy and a way to jump back up a level.

Quick Start

A page under app/features/api/ renders a breadcrumb from its slug.

Plain Text
Plain Text
Features / API / API Blocks

Adding Options

Directory names are formatted into display labels, with technical acronyms preserved in their canonical casing.

Advanced

Breadcrumbs resolve automatically from the navigation tree, so a page added anywhere under app/ gets a correct trail with no manual configuration. The same labels feed structured BreadcrumbList JSON-LD for search engines.

Options

pathstringrequired

The page slug, derived from its file path.

Was this page helpful?