Adding local search with @cmfcmf-plugin (#78)

README.md

@@ -17,6 +17,17 @@ npm install
 npm run start
 ```
 
+### Run docs with search feature enabled
+
+Instead of `npm run start`, you'll need to:
+
+```bash
+npm run docusaurus build
+npm run docusaurus serve
+```
+
+If you change the [search configuration](/docusaurus.config.js#L27), you'll need to run `npm run docusaurus build` and then `npm run docusaurus serve` again to refresh with the changes.
+
 ## Contribution Guidelines
 
 Thank you for your interest in contributing to improve the documentation!
@@ -40,7 +51,7 @@ If you find anything that is confusing or can be improved in an existing documen
 
 When **adding a new page**, you need to fork the repository, create a new branch, and make all changes necessary in your repository. Once you are done with your changes, create a PR to Scaffold-ETH 2 Documentation repository.
 
-Add the new pages to the `docs` folder, placing them in the specific directory where you want the page to be shown.  
+Add the new pages to the `docs` folder, placing them in the specific directory where you want the page to be shown.
 **Siderbar** link will get **autogenerated** under your specific folder, in the **position** that you specify in your document header. Example:
 
 ```markdown

docusaurus.config.js

@@ -20,7 +20,15 @@ const config = {
   // If you aren't using GitHub pages, you don't need these.
   organizationName: "scaffold-eth",
   projectName: "scaffold-eth-2",
-
+  plugins: [
+    [
+      require.resolve("@cmfcmf/docusaurus-search-local"),
+      {
+        indexBlog: false,
+        includeParentCategoriesInPageTitle: true,
+      },
+    ],
+  ],
   scripts: [
     {
       src: "https://plausible.io/js/plausible.js",

package.json

@@ -16,6 +16,7 @@
     "format-check": "npx prettier --check '**/*.{js,jsx,md,mdx,json,css}'"
   },
   "dependencies": {
+    "@cmfcmf/docusaurus-search-local": "^1.2.0",
     "@docusaurus/core": "2.4.0",
     "@docusaurus/preset-classic": "2.4.0",
     "@mdx-js/react": "^1.6.22",