Exclude pages from search

[xmatthias]

We're using imports (--8<-- "commands/somepage.md") to import common sub-sections of our page.
These pages are hidden from the navigation (explicitly configured navigation) - and are intended to not be navigated to directly.

If using the search however - these pages often show up as the first result - which is clearly not what we want (it's pages for reusability which shouldn't be navigated to directly).

Using the search.exclude front-matter doesn't work for imported files - as it'll render like this:

(with the top section coming from the parent, and the --- and the code block coming from the imported file).

Ideally, i'd like to use something like the following to exclude that whole directory - but from the docs - i didn't find this being possible?

- search.exclude:
      - commands/**    

[kamilkrzyskow]

Hello @xmatthias,
your snippets shouldn't be inside of your docs directory, the Snippets extension copies the text files as is, without support for MkDocs meta header. MkDocs creates a Page object from every Markdown file inside docs, and the meta only works in that case.

Either move the snippets outside docs and change the base_path of the Snippets extension, or use the exclude_docs option to turn off the Page object creation and remove the search exclude header.

Or maybe I misunderstood, and you're looking to exclude sections that are inserted via the snippets extension, then maybe this part of the documentation will help you:

• https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#excluding-sections

[xmatthias]

Hm that's a great catch, thanks!

with exclude_docs it now works perfectly 👍
(for future readers) Looks like this in my case

exclude_docs: |
    /commands/*