Leed Partial Index

You saw a {{> leed/something }} in a template and you want to know three things: what it is, whether you are allowed to call it, and where it is explained. This page answers all three, for all 54 partials Leed injects into src/_includes/leed/ on every build.

Every one of them follows the ordinary naming rule — the partial’s name is its path under src/_includes/ with .hbs stripped — so leed/docs/header/brand is the file src/_includes/leed/docs/header/brand.hbs during the build, and nothing else. There is no registry and no special casing of the leed/ prefix; the namespace exists only because that is the directory Leed’s files land in. Writing Your Own Partials covers the same rule for your own files.

The three statuses

Every row below carries one of three statuses, and they mean precisely this:

StatusCountWhat it means
Usable9Documented, parameterized, and safe to call from your own templates. Its name, parameters and markup are part of Leed’s contract with you.
Eject source3Not something you call. It is the Leed default that leed site eject copies into your repository so you can edit it and take ownership.
Internal42Called by Leed’s own templates. Names, parameters and emitted markup change between releases without notice.

The nine you can use

PartialWhat it rendersRequired parametersDocumented on
leed/headThe complete contents of a page’s <head>: stylesheet, metadata, scriptsnoneHead and Component Partials
leed/menu/builderAny menu you built in the CMS, as a nested <ul>menuNameMenu Partials
leed/formA form defined in the CMS, wired to submission handlingformId (or the page’s own form setting)Form Partial
leed/components/paginationRange text, numbered links and arrows for a paginated listnone (reads @root/list)Head and Component Partials
leed/components/scroll-status-indicator-horizontalA reading-progress bar for one scrollable regionscrollBarIdHead and Component Partials
leed/popup-videoA button that opens a modal Cloudflare Stream playerbuttonLabel, videoAssetId, videoSrcHead and Component Partials
leed/docs/social-iconsOne linked icon per configured social accountnoneDocumentation Shell Partials
leed/docs/document-searchThe documentation search trigger, full or compactnoneDocumentation Shell Partials
leed/unsubscribe-formThe static unsubscribe reason formnoneForm Partial

The complete index

Fifty-four files, in path order, grouped by directory. The counts add up: 5 + 3 + 3 + 2 + 29 + 12 = 54. Re-run the enumeration against src/_includes/leed/ after a build if you need to be certain for a given release — the set moves with the site builder, not with your repository.

leed/ root — 5

PartialStatusCalled byRequiresDocumented on
leed/formusableyou — from a template, or from page content through process—Form Partial
leed/headusableyou, plus leed/docs/shell and Leed’s unsubscribe root templates—Head and Component Partials
leed/popup-videousableyou—Head and Component Partials
leed/stub-templateeject sourcethe stub transformer, not a partial callGrowth (recommendationEngine)Overriding Leed Templates
leed/unsubscribe-formusableleed-unsubscribe.hbs—Form Partial

leed/menu/ — 3

PartialStatusCalled byRequiresDocumented on
leed/menu/builderusableyou, plus leed/docs/sidebar, header/nav, docs-footer, docs-header—Menu Partials
leed/menu/iteminternalleed/menu/builder, and itself (recursion)—Menu Partials
leed/menu/linkinternalleed/menu/item—Menu Partials

leed/metadata/ — 3

PartialStatusCalled byRequiresDocumented on
leed/metadata/siteMetadatainternalleed/head—Head and Component Partials
leed/metadata/ogCardinternalleed/head—Head and Component Partials
leed/metadata/twitterCardinternalleed/head—Head and Component Partials

They are internal because leed/head already calls all three in order. Call one yourself and you emit a second copy of the same <meta> tags.

leed/components/ — 2

PartialStatusCalled byRequiresDocumented on
leed/components/paginationusableyou—Head and Component Partials
leed/components/scroll-status-indicator-horizontalusableyou, plus leed/docs/header/chrome—Head and Component Partials

leed/docs/ — 29

Twenty-nine files render every documentation page. Four of them are yours to touch: social-icons and document-search are callable, and docs-header / docs-footer are the two eject sources. The other twenty-five are the shell’s own machinery.

PartialStatusCalled byRequiresDocumented on
leed/docs/shellinternalalpha/base, bravo/base, charlie/base—Documentation Shell Partials
leed/docs/sidebarinternalthe three <theme>/base partials—Documentation Shell Partials
leed/docs/mini-barinternalall six <theme>/documentation and <theme>/api partials—Documentation Shell Partials
leed/docs/tocinternalthe three <theme>/documentation partials—Documentation Shell Partials
leed/docs/doc-articleinternalthe three <theme>/documentation partials—Documentation Shell Partials
leed/docs/api-articleinternalthe three <theme>/api partials—Documentation Shell Partials
leed/docs/paginationinternaldoc-article, api-article—Documentation Shell Partials
leed/docs/footerinternalleed/docs/shell, bravo/base, leed/docs/pagination—Customizing the Documentation Header and Footer
leed/docs/docs-footereject sourceleed/docs/footer, when no override existsStarter, to overrideCustomizing the Documentation Header and Footer
leed/docs/docs-headereject sourcenothing — it is a worked example, not the shipped headerStarter, to overrideCustomizing the Documentation Header and Footer
leed/docs/social-iconsusableleed/docs/docs-footer, and you—Documentation Shell Partials
leed/docs/document-searchusableheader/top-search, header/compact, and you—Documentation Shell Partials
leed/docs/document-search-modalinternalleed/docs/shell, once per page—Documentation Shell Partials
leed/docs/styleinternalleed/head—Head and Component Partials
leed/docs/header/chromeinternalheader/top-search, header/compact—Customizing the Documentation Header and Footer
leed/docs/header/top-searchinternalleed/docs/shell, on alpha and charlie—Documentation Shell Partials
leed/docs/header/compactinternalleed/docs/shell, on bravo—Documentation Shell Partials
leed/docs/header/brandinternalheader/top-search, header/compact—Documentation Shell Partials
leed/docs/header/navinternalheader/top-search, header/compact—Documentation Shell Partials
leed/docs/header/ctainternalheader/top-search, header/compact—Documentation Shell Partials
leed/docs/alpha/baseinternal_layouts/leed-documentation.hbs, when layoutName is alpha—Documentation Layouts
leed/docs/alpha/documentationinternalalpha/base—Documentation Layouts
leed/docs/alpha/apiinternalalpha/base—Documentation Layouts
leed/docs/bravo/baseinternal_layouts/leed-documentation.hbs, when layoutName is bravo—Documentation Layouts
leed/docs/bravo/documentationinternalbravo/base—Documentation Layouts
leed/docs/bravo/apiinternalbravo/base—Documentation Layouts
leed/docs/charlie/baseinternal_layouts/leed-documentation.hbs, when layoutName is charlie—Documentation Layouts
leed/docs/charlie/documentationinternalcharlie/base—Documentation Layouts
leed/docs/charlie/apiinternalcharlie/base—Documentation Layouts

Two rows invite a misreading. leed/docs/docs-header is not what renders on your documentation pages — it is a complete, working example header that exists so leed site eject docs-header has something real to copy. What actually renders is leed/docs/header/chrome wrapping one of the two header variants. And leed/docs/footer is the slot, while leed/docs/docs-footer is the default that fills it; the override replaces the second, never the first.

leed/api/ — 12

All twelve render the OpenAPI reference body inside leed/docs/api-article, and all twelve are internal. You will meet them only when you are reading generated API markup or tracing a class name in it.

The twelve leed/api/** partials
PartialStatusCalled byRequiresDocumented on
leed/api/securityinternalleed/docs/api-article—API Reference Pages
leed/api/security-constraintsinternalleed/api/security—API Reference Pages
leed/api/parametersinternalleed/docs/api-article, once per parameter location—API Reference Pages
leed/api/propertyinternalleed/api/parameters, leed/api/object, and itself—API Reference Pages
leed/api/objectinternalleed/api/property, request-body, responses—API Reference Pages
leed/api/request-bodyinternalleed/docs/api-article—API Reference Pages
leed/api/responsesinternalleed/docs/api-article—API Reference Pages
leed/api/bits/array-typeinternalleed/api/property, leed/api/object—API Reference Pages
leed/api/bits/badgesinternalleed/api/property, leed/api/object—API Reference Pages
leed/api/bits/descriptioninternalleed/api/property, leed/api/object—API Reference Pages
leed/api/bits/examplesinternalleed/api/property, leed/api/security-constraints—API Reference Pages
leed/api/bits/scopesinternalleed/api/property, leed/api/security-constraints—API Reference Pages

How these files get there

None of these files is in your repository. They are copied out of the site-builder package into src/_includes/leed/ at the start of every build and serve, and deleted again when the run ends. They are gitignored, so git status never shows them.

Two consequences. An edit under _includes/leed/ never survives — the next build overwrites it and the cleanup deletes it, which is why a “my change did nothing” report almost always turns out to be an edit in that directory. And the supported way to change one of Leed’s own templates is an override, not an edit: three of the fifty-four are starting points that leed site eject copies into your repository for you, described at Leed Site Eject, with the render-time contract at Overriding Leed Templates. Which directories in your clone are yours and which Leed rewrites is mapped at Editable and Read-Only Files.

Helpers have their own parallel index — everything you can call between the braces rather than after {{> is at the Helper Index.

ESC