-
-
Notifications
You must be signed in to change notification settings - Fork 482
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a pagefind
boolean flag to user config
#1144
Conversation
Formatting is intentionally weird in this file to help simplify merging with #1135
🦋 Changeset detectedLatest commit: f137590 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
size-limit report 📦
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs review! Some comments suggested.
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks perfect and ready to me 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM ✅
I'm considering an API structure like this: search: 'pagefind' // or false I find this setup more explicit in its configuration. Additionally, this API structure could potentially pave the way for other official plugins (if any) like 'algolia', although that's beyond the scope of this comment. What are your thoughts on this approach? |
Interesting idea! But I'm pretty confident that we won't have other search providers built-in. Feedback about Pagefind has been very positive and it fits really nicely into Starlight's architecture. So this option would end up having only one possible value, which suggests the Boolean toggle probably works well I think. Alternative search providers could still be added via the new plugins API (#942) but they would then be configured in the plug-in options rather than in the global Starlight config. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lively Groove, Tune Mastered!
Description
pagefind
boolean to user config that can be set tofalse
to disable Pagefind indexing and skip rendering the default search UI.