Documentation Explorer

Documentation Explorer cards on the hub page.
Documentation Explorer cards on the hub page.

Usage

Documentation Explorer lists published docs on a page. Visitors can search and filter by type, product, and brand.

Place it inside a Section (or a column). The inserter hides it at the root of the page.

On the Documentation Base Page, hub URLs drive the list. A Viewing: line names the active type, product, or brand. Reset filters clears search and hub filters. Those controls are on the front end, not in the block sidebar.

When to use it

Use Explorer as the main library on the hub page. Use Product Downloads instead when a product landing page should list only that product’s files.

Tips

  • Set Documentation Source to By Type, By Product, or By Brand when this block should start from a subset. Filters still apply on top of that subset.
  • Cards is a grid with optional excerpts. Tiers groups files under Doc Type headings.
  • Leave Filter by Types, Filter by Products, or Filter by Brands empty to offer every term. The pickers appear only when that filter is on.

Settings

Documentation Explorer

Documentation Source setting in the block editor sidebar
Documentation Source

Which docs this block starts from. Filters and hub URLs still narrow that set.

  • Show All defaultEvery published doc.
  • By TypeOnly docs in the types you pick next.
  • By ProductOnly docs in the products you pick next.
  • By BrandOnly docs in the brands you pick next.
Select Types setting in the block editor sidebar
Select TypesAvailable when Documentation Source is “By Type”

Set Documentation Source to By Type first. Pick one or more Doc Types.

Select Products setting in the block editor sidebar
Select ProductsAvailable when Documentation Source is “By Product”

Set Documentation Source to By Product first. Pick one or more Doc Products.

Select Brands setting in the block editor sidebar
Select BrandsAvailable when Documentation Source is “By Brand”

Set Documentation Source to By Brand first. Pick one or more Doc Brands.

Show Type Filter setting in the block editor sidebar
Show Type Filter

Shows the Type picker visitors use on the page.

Filter by Types setting in the block editor sidebar
Filter by TypesAvailable when Show Type Filter is enabled

Which types appear in that picker. Set Show Type Filter on first. Leave empty to include all types.

Show Product Filter setting in the block editor sidebar
Show Product Filter

Shows the Product picker visitors use on the page.

Filter by Products setting in the block editor sidebar
Filter by ProductsAvailable when Show Product Filter is enabled

Which products appear in that picker. Set Show Product Filter on first. Leave empty to include all products.

Show Brand Filter setting in the block editor sidebar
Show Brand Filter

Shows the Brand picker visitors use on the page.

Filter by Brands setting in the block editor sidebar
Filter by BrandsAvailable when Show Brand Filter is enabled

Which brands appear in that picker. Set Show Brand Filter on first. Leave empty to include all brands.

Show Text Search setting in the block editor sidebar
Show Text Search

Shows the search field above the list.

Layout setting in the block editor sidebar
Layout

How the results are arranged. Cards is a grid. Tiers groups files under Doc Type headings.

  • Cards defaultA card grid. Show Excerpt and Grid Gap appear for this layout.
  • TiersHeadings per Doc Type, then a list. Columns appears for this layout.
Columns setting in the block editor sidebar
ColumnsAvailable when Layout is “Tiers”

How many columns each type list uses. Set Layout to Tiers first.

  • 1
  • 2default
  • 3
Show Excerpt setting in the block editor sidebar
Show ExcerptAvailable when Layout is “Cards”

Shows each doc’s excerpt on the card. Set Layout to Cards first.

Grid Gap setting in the block editor sidebar
Grid GapAvailable when Layout is “Cards”

Space between cards. Set Layout to Cards first.