search

praveenn77 / docusaurus-lunr-search

Local / Offline Search for docusaurus
https://praveenn77.github.io/docusaurus-lunr-search-demo/
MIT License
488 stars 79 forks source link

Confusing install instructions in README #93

Closed seekayel closed 1 year ago

seekayel commented 1 year ago

The README provides the following How to Use instructions:

  1. Install this package
  2. Then run npm install to update, build, and link the packages
  3. Add the docusaurus-lunr-search plugin to your docusaurus.config.js
  4. Then run docusaurus swizzle
  5. Then build your Docusaurus project
  6. Serve your application

However, if you skip step 4 everything works fine. If you attempt to edit the files by step 4 they aren't used due to the plugin being loaded from the npm module (step 3).

Question: how to swizzle and customize? Once I swizzle those files don't get used.

Suggestion: make it more clear that swizzling is not needed to use this plugin.

Thanks.

AddictArts commented 1 year ago

I can verify swizzling is not needed. Most likely this is suggesting a person might want to customize.

See https://docusaurus.io/docs/swizzling

Once swizzled you wrap it in your src/ or provide a new implementation as I can tell from reading the docs, but that is not a plugin issue, or this plugins specific thing.

praveenn77 commented 1 year ago

Read me updated