Question: Exclude from Local Search and display Frontmatter data

[mitchellknight]

The new Local Search is great! I just have a few questions:

1. How do I exclude results from Local Search? For example, let's say I had a /secret/ folder that I would like to exclude all subpages from search results, how would I do that?
2. How do I get Local Search to use frontmatter data (see screenshot)?

[jeremyriverain]

Hi,

I am currently migrating a doc website from Vuepress to Vitepress. I would like to exclude certain content from the search results but I can't find a way to do it with Vitepress. This ticket seems to indicate that it could be an improvement to Vitepress. Is this a possible development?

I have time to work on this subject. I can contribute.

Is there a particular direction you would like to take on this subject? Which API expose?

I imagine 2 ways to exclude content from search results.

1. from the .vitepress/config.ts file, by adding a new parameter, like isSearchable:

// .vitepress/config
export default defineConfig({
  themeConfig: {
    search: {
      provider: 'local',
      options: {
        isSearchable (pageData) {
          return !pageData.startsWith('/excluded-folder')
        },
      },
    },
})

2. at the level of each page, by taking into account a new frontmatter property:

---
search: false
---

<!-- excluded-folder/index.md -->
# my content excluded from search results

What do you think ?

[brc-dd]

Yeah contributions are welcome. Make the API something like this:

interface LocalSearchOptions {
  exclude: (pageData: PageData) => boolean
}

So that function can be:

return pageData.relativePath.startsWith('/excluded-folder') || pageData.frontmatter.search === false