Display options

Display options are optional. Start without them, then add only the overrides your site needs.

Defaults

Homepage defaults:

Writing dates, tags, and authors are shown by default on writing previews and indexes when the corresponding frontmatter exists. Control them independently with showDate, showTags, and showAuthor.

Descriptions on the homepage are opt-in. showDescription: false and an omitted showDescription both hide descriptions.

Homepage

Use home for the front page preview sections:

home: {
  previewLimit: 3,
  order: ['docs', 'writing'],
  collections: {
    writing: {
      showDate: false,
      showTags: false,
      showAuthor: false,
      showDescription: true,
    },
  },
}

home.order controls section order. Entries are collection keys such as works, not the display label. Omit home.order to use enabled collections in default order, or set home.preset to lab, blog, docs-writing, or persona for init-style ordering. See Site layout.

home.previewLimit controls how many entries each homepage section shows. Omit it to use 5.

Layout

Use layout: 'list' for compact rows:

home: {
  collections: {
    writing: {
      layout: 'list',
    },
  },
}

Use layout: 'card' for richer rows:

home: {
  collections: {
    docs: {
      layout: 'card',
      showDescription: true,
    },
  },
}

If layout: 'card' is set but showDescription is not true, homepage previews stay compact: title on the left, date on the right for writing entries.

Gap

Spacing presets:

home: {
  collections: {
    docs: {
      gap: 'lg',
    },
  },
}

Collection Indexes

Use collections.<key>.display for collection index pages:

collections: {
  writing: {
    display: {
      layout: 'card',
      gap: 'md',
      showDate: true,
      showTags: true,
      showAuthor: true,
      showDescription: true,
    },
  },
}

Collection index display and homepage display are separate. A writing index can show descriptions while the homepage keeps writing previews compact.

Tags And Icons

Entries can define tags and icons:

---
title: Release notes
date: 2026-05-22
icon: /images/release.svg
tags: [release, notes]
---

Writing tags render by default. Other collection kinds remain opt-in. Set showTags: false at either display boundary to hide them.

Authors use the optional author frontmatter field and render by default for writing when present. showAuthor is independent of showDate, so either value can be hidden without affecting the other.

Icons render on card-style previews when an entry or display config provides an icon.

Search

Pagefind indexes enabled content collections (everything except kind: 'page'). Each searchable region gets a collection:<key> filter attribute.

Before a visitor types, the search dialog shows up to six direct destinations. TidyPress derives these from the first sidebar pages by default. Define the exact high-value routes—or set an empty array to hide the initial list:

search: {
  shortcuts: [
    { label: 'Quickstart', href: '/docs/getting-started', description: 'Install and run locally' },
    { label: 'CLI reference', href: '/docs/reference/cli' },
  ],
}

The shortcut list disappears as soon as the visitor types and returns when the query is cleared.

When two or more collections are searchable, the header search modal shows filter chips (All, writing, projects, and so on). Pick a chip to scope results to that collection.

Standalone pages (kind: 'page') are not included in collection filter chips. Set search: false on an entry to exclude it from the index.