feat(search): allow excluding content from search results (#2602)

closes #2344

Co-authored-by: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>

Author: Jérémy Riverain

__tests__/e2e/.vitepress/config.ts

@@ -87,6 +87,14 @@ export default defineConfig({
   title: 'Example',
   description: 'An example app using VitePress.',
   themeConfig: {
-    sidebar
+    sidebar,
+    search: {
+      provider: 'local',
+      options: {
+        exclude(relativePath) {
+          return relativePath.startsWith('local-search/excluded')
+        }
+      }
+    }
   }
 })

__tests__/e2e/local-search/excluded.md

@@ -0,0 +1 @@
+# Local search config excluded

__tests__/e2e/local-search/frontmatter-excluded.md

@@ -0,0 +1,5 @@
+---
+search: false
+---
+
+# Local search frontmatter excluded

__tests__/e2e/local-search/index.md

@@ -0,0 +1 @@
+# Local search included

__tests__/e2e/local-search/local-search.test.ts

@@ -0,0 +1,34 @@
+describe('local search', () => {
+  beforeEach(async () => {
+    await goto('/')
+    // FIXME: remove this when optimizeDeps.include is fixed
+    await page.locator('#local-search button').click()
+    await goto('/')
+  })
+
+  test('exclude content from search results', async () => {
+    await page.locator('#local-search button').click()
+
+    const input = await page.waitForSelector('input#localsearch-input')
+    await input.type('local')
+
+    await page.waitForSelector('ul#localsearch-list', { state: 'visible' })
+
+    const searchResults = page.locator('#localsearch-list')
+    expect(await searchResults.locator('li[role=option]').count()).toBe(1)
+
+    expect(
+      await searchResults.filter({ hasText: 'Local search included' }).count()
+    ).toBe(1)
+
+    expect(
+      await searchResults.filter({ hasText: 'Local search excluded' }).count()
+    ).toBe(0)
+
+    expect(
+      await searchResults
+        .filter({ hasText: 'Local search frontmatter excluded' })
+        .count()
+    ).toBe(0)
+  })
+})

__tests__/e2e/package.json

@@ -5,7 +5,9 @@
   "scripts": {
     "test": "vitest run",
     "watch": "DEBUG=1 vitest",
-    "site": "vitepress"
+    "site:dev": "vitepress",
+    "site:build": "vitepress build",
+    "site:preview": "vitepress preview"
   },
   "devDependencies": {
     "vitepress": "workspace:*"

docs/reference/default-theme-search.md

@@ -98,6 +98,24 @@ export default defineConfig({
 
 Learn more in [MiniSearch docs](https://lucaong.github.io/minisearch/classes/_minisearch_.minisearch.html).
 
+### Excluding pages from search
+
+You can exclude pages from search by adding `search: false` to the frontmatter of the page. Alternatively, you can also pass `exclude` function to `themeConfig.search.options` to exclude pages based on their path relative to `srcDir`:
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  themeConfig: {
+    search: {
+      options: {
+        exclude: (path) => path.startsWith('/some/path')
+      }
+    }
+  }
+})
+```
+
 ## Algolia Search
 
 VitePress supports searching your docs site using [Algolia DocSearch](https://docsearch.algolia.com/docs/what-is-docsearch). Refer their getting started guide. In your `.vitepress/config.ts` you'll need to provide at least the following to make it work:

package.json

@@ -69,7 +69,9 @@
     "test:unit": "vitest run -r __tests__/unit",
     "test:unit:watch": "vitest -r __tests__/unit",
     "test:e2e": "run-s test:e2e-dev test:e2e-build",
-    "test:e2e:site": "pnpm -F=tests-e2e site",
+    "test:e2e:site:dev": "pnpm -F=tests-e2e site:dev",
+    "test:e2e:site:build": "pnpm -F=tests-e2e site:build",
+    "test:e2e:site:preview": "pnpm -F=tests-e2e site:preview",
     "test:e2e-dev": "pnpm -F=tests-e2e test",
     "test:e2e-dev:watch": "pnpm -F=tests-e2e watch",
     "test:e2e-build": "VITE_TEST_BUILD=1 pnpm test:e2e-dev",
@@ -100,7 +102,7 @@
     "mark.js": "8.11.1",
     "minisearch": "^6.1.0",
     "shiki": "^0.14.3",
-    "vite": "^4.4.4",
+    "vite": "^4.4.6",
     "vue": "^3.3.4"
   },
   "devDependencies": {
@@ -138,7 +140,7 @@
     "conventional-changelog-cli": "^2",
     "cross-spawn": "^7.0.3",
     "debug": "^4.3.4",
-    "esbuild": "^0.18.14",
+    "esbuild": "^0.18.15",
     "escape-html": "^1.0.3",
     "execa": "^7.1.1",
     "fast-glob": "^3.3.0",