Search in sections only

[Darrelk]

Hello,

I would like to know if there is a way to configure mkdocs-material to search within a section only, and not across the entire site?

Sample navigation config:

nav:
  - Home: index.md
  - User guides:
    - Getting started: UserGuides/GettingStarted.md 
    - Installation:
      - Install windows: UserGuides/installWin.md
      - Install mac: UserGuides/installMac.md    
  - Integration:
      - Doc 1: Integration/Doc1.md 
      - Doc 2: Integration/Doc2.md 
      - Doc 3: Integration/Doc3.md 
      - Doc 4: Integration/Doc4.md 

Using the above configuration, I would like to search all sections when on the home page, but only the main section if in child documents. So all pages within the "User guides" section when on any of those pages, and no results in the "integration" section if not in that section. If this makes sense?

[squidfunk]

Some options:

• You could build different MkDocs sites per section and combine them into one, so all search indexes are separate.
• You could patch the query transform and always add a term that only occurs in a section, similar to query +section. The + modifier ensures that the term must occur. You could also use tags to identify sections.

[dobl1]

Hi @squidfunk,

Interested in the same behaviour.
It is possible to search filtering by Tag ? like tag:something search terms or even adding a list of tags to the search engine with buttons / list (filters) to search only on pages thats contains this tag(s).

Thank you for your work and this incredible tool (I talk about it a lot around me, and push into my compagny (OSS software publisher) to be a sponsor)

[squidfunk]

Yes, tags are integrated with search! If you tag your pages, they will be discoverable by tag:
https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#__tabbed_2_2

If you add a + before the tag name when searching, only pages with that tag will be included.