Skip to content

New Pagefind UI v2 - #4307

Draft
HiDeoo wants to merge 38 commits into
withastro:mainfrom
HiDeoo:hd/feat-pagefind-component-ui
Draft

HiDeoo wants to merge 38 commits into
withastro:mainfrom
HiDeoo:hd/feat-pagefind-component-ui

Conversation

@HiDeoo

@HiDeoo HiDeoo commented Oct 28, 2026

Copy link
Copy Markdown
Member

Description

This PR is a draft of the rewrite of the Pagefind UI that is used in Starlight. This is an alternative approach to #3335 that uses the new Pagefind Component UI.

This is a work in progress and is not ready for review yet as I'm still reviewing some implementation details and a11y requirements. I am also working on a list of upstream changes/fixes to share with Liam that would be needed (and I can work on them) if we want to move forward with this approach.

I will be sharing more details and updates here as the work progresses.

Like #3335, this PR also adds support for new features which are currently not supported at all in Starlight.

Development notes

  • This PR adds the pnpm pagefind command to the docs/ directory which should be used when iterating on this PR:
    • It first runs a complete build, copy dist/pagefind to public/pagefind and runs a development server.
    • When developing, visiting http://localhost:4321 will use the search indexes from the prod version which allows for using/testing/iterating on the search UI (note that changes that would result in a change to the search indexes will require running the pnpm pagefind command again).

Remaining tasks

  • Look for any TODO(HiDeoo) comments and address them.
  • Remove the pagefind npm script from the docs/ directory.
  • Add changeset(s)

@changeset-bot

changeset-bot Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1893a36

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@astrojs/starlight Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions Bot added 📚 docs Documentation website changes 🌟 core Changes to Starlight’s main package labels Oct 28, 2026
@netlify

netlify Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for astro-starlight ready!

Name Link
🔨 Latest commit 1893a36
🔍 Latest deploy log https://app.netlify.com/projects/astro-starlight/deploys/6afb177416eecf1024a34aa5
😎 Deploy Preview https://deploy-preview-4307--astro-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@astrobot-houston

astrobot-houston commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the tracking.ignoredKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
demo/trigger-filters.md Localization added, will be marked as complete.
demo/trigger-search.md Localization added, will be marked as complete.
guides/i18n.mdx Source changed, localizations will be marked as outdated.
guides/site-search.mdx Source changed, localizations will be marked as outdated.
reference/configuration.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Comment thread docs/src/components/icons-list.astro Resolved
* main: (42 commits)
  Replace `js-yaml` with `yaml` (withastro#4218)
  i18n(de): improve `configuration` and `frontmatter` (withastro#4335)
  i18n(de): fix `findst` typo (withastro#4333)
  i18n(de): fix `Überschriftenebene` spelling (withastro#4334)
  Preserve prototype-named directories in localized routes (withastro#4316)
  i18n(de): update `plugins.mdx` (withastro#4330)
  i18n(es): update icons.mdx (withastro#4329)
  i18n(es): update badges.mdx (withastro#4327)
  i18n(es): update asides.mdx and icons.mdx (withastro#4326)
  docs: add @heydeacon/starlight to community plugins (withastro#4319)
  i18n(ko-KR): update `community-content`, `plugins` (withastro#4321)
  i18n(ru): update translations (withastro#4320)
  Prettier update follow-up (withastro#4322)
  [i18nIgnore] Update to v1 of `prettier-plugin-astro` (withastro#4175)
  [ci] release (withastro#4298)
  docs: fix icon name search (withastro#4310)
  i18n(ja): update plugins.mdx and community-content.mdx (withastro#4311)
  Fix Object.prototype property names in autogenerated sidebars (withastro#4309)
  Fix last updated dates for file paths containing special characters (withastro#4290)
  Fix `size-limit` CI job (withastro#4308)
  ...
"@types/hast": "^3.0.5",
"@types/mdast": "^4.0.4",
"astro-expressive-code": "^0.44.0",
"bcp-47": "^2.1.0",

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bumped to match the @pagefind/component-ui requirement and avoid 2 copies.

@codspeed

This comment was marked as low quality.

* main: (62 commits)
  docs: point the changeset link at the current Changesets docs (withastro#4387)
  i18n(ko-KR): update `configuration`, `overrides` (withastro#4399)
  i18n(ja): update plugins.mdx (withastro#4403)
  i18n(ja): update overrides.md (withastro#4401)
  i18n(ja): update configuration.mdx (withastro#4402)
  i18n(ja): update site-search.mdx (withastro#4400)
  i18n(de): update `resources/plugins` (withastro#4407)
  i18n(de): update `overrides.mdx` (withastro#4406)
  i18n(de): update `configuration.mdx` (withastro#4405)
  i18n(de): update `site-search.mdx` (withastro#4404)
  [ci] release (withastro#4398)
  fix: restore aside component icon size (withastro#4396)
  i18n(es): update project-structure.mdx (withastro#4393)
  [ci] release (withastro#4391)
  Update peter-evans/create-pull-request action to v8.1.3 (withastro#4392)
  Allow passing user options to `pagefind.createIndex` (withastro#3674)
  Refactor `ThemeSelect` to use CSS instead of JS for icon updates (withastro#4219)
  Support any `scopedStyleStrategy` (withastro#4190)
  Update i18next to v27 (withastro#4385)
  Fix asides accepting Object.prototype property names as custom icons (withastro#4390)
  ...

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🌟 core Changes to Starlight’s main package 📚 docs Documentation website changes 🌟 minor Change that triggers a minor release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants