Skip to content
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

Present pagefind plugin as a theme #49

Closed
bohyunjung opened this issue Jul 31, 2024 · 2 comments
Closed

Present pagefind plugin as a theme #49

bohyunjung opened this issue Jul 31, 2024 · 2 comments

Comments

@bohyunjung
Copy link

bohyunjung commented Jul 31, 2024

Hi, I found this repo from facebook/docusaurus#10345, and I'm happy to see a new option for searching on Docusaurus.

There are two things I'd like to suggest regarding @getcanary/docusaurus-pagefind. (before things get too complicated to change!)

Present it as a theme

I use https://github.com/easyops-cn/docusaurus-search-local, which was initially a plugin but was changed to a theme. Please refer to facebook/docusaurus#6488 (comment) and I think it's worth following the precedents.

Rename it

Suppose you agree with deploying it as a theme - While the name of docusaurus-pagefind is straightforward, giving a name like docusaurus-theme-search-pagefind might enhance the branding of the theme. These are some examples I referred to the naming style.

@yujonglee
Copy link
Contributor

https://docusaurus.io/docs/using-plugins#using-themes

From the consumer perspective, the themes and plugins entries are interchangeable when installing and configuring a plugin. The only nuance is that themes are loaded after plugins, and it's possible for a theme to override a plugin's default theme components.

@yujonglee
Copy link
Contributor

143b0bd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants