Search filter

[wayneamurphy]

DocFX Version Used: 2.35.4

Template used: default

Steps to Reproduce:

1. generate with basic options

Expected Behavior: have ability to apply filter to top search

Actual Behavior: I don't see a mechanism for this in the documentation

I'm a newbie so I could have easily missed it... Looking at the Microsoft Dynamics docs they have a way to apply a filter in the top search box. Is this a custom post-processing step they've done - or did I just not see it in the FxDoc documentation?

[superyyrrzz]

Hi @wayneamurphy , the default template of DocFX supports search by setting _enableSearch to be true in globalMetadata. See http://dotnet.github.io/docfx/tutorial/docfx.exe_user_manual.html

Note that this is based on lunar, which a bit different from what you see on docs.microsoft.com.

[wayneamurphy]

Thanks superyyrrzz, I had already enabled the search - my question was specifically for that filter they put into the search box (so when you try to search in https://docs.microsoft.com/en-us/dynamics365/business-central/index they already have a "BusinessCentral" value stuck in there) I wasn't sure if it was an undocumented feature in DocFX or I missed that doc page, or just something Microsoft did themselves. I'm assuming by response that it was just some Microsoft magic.

Do you think it is worth adding as a possible feature in the future?

[vwxyzh]

@wayneamurphy Docs site use a search service, it is not open source yet.

[herohua]

@qinezh , I am not familiar with the search mechanism in the default template, but do you think it is possible to support scope in the search? How much effort will it be?

@superyyrrzz @vwxyzh as FYI

[qinezh]

As @vwxyzh mentioned, Docs sites enable search scope for cross-sites searching, and the target is different with full-text search built-in DocFX which only supports current site.

cc @herohua

[informnaveed]

@qinezh even within same site can we add the search tag auto populated based on the folder strcture?

[herohua]

Reopen the issue as it is raised up by another team

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.