Expose the url of the search_index.json file as configurable content

[Explorer-Dong]

Since my private cloud server has limited bandwidth, when the search_index.json file is large, the time overhead of search initialization is unbearable. If the URL of the search_index.json file can be exposed, I can store the file on the CDN to speed up the initialization of the search function.

[kamilkrzyskow]

Hey @Explorer-Dong,
maybe you could take a look at this hack:

• Disabling media pause when switching content tabs. #6844 (reply in thread)

You would replace the minified new URL("sitemap.xml", base), with new URL(CDN), perhaps it would work, assuming proper CORS handling on your part.
I think that the sitemap.xml value is unique enough for this regex matching hack 🙂

[Explorer-Dong]

@kamilkrzyskow Thanks for your reply. Your method is indeed effective. But maybe you can directly expose search_index.json as a variable that can be configured in the mkdocs.yml file instead of hard-coding it in:

mkdocs-material/src/templates/assets/javascripts/bundle.ts

Lines 101 to 116 in 7b83b57

	function fetchSearchIndex(): Observable<SearchIndex> {
	if (location.protocol === "file:") {
	return watchScript(
	`${new URL("search/search_index.js", config.base)}`
	)
	.pipe(
	// @ts-ignore - @todo fix typings
	map(() => __index),
	shareReplay(1)
	)
	} else {
	return requestJSON<SearchIndex>(
	new URL("search/search_index.json", config.base)
	)
	}
	}

I am not familiar with javascript, is this change difficult?

The example configuration is as follows:

https://github.com/fluid-dev/hexo-theme-fluid/blob/master/_config.yml#L377-L388

The example implementation is as follows:

https://github.com/fluid-dev/hexo-theme-fluid/blob/master/source/js/local-search.js#L24-L36

[kamilkrzyskow]

I am not familiar with javascript, is this change difficult?

Not difficult, but involves multiple files. MkDocs generates static HTML, so the config from mkdocs.yml needs to be transferred to the client side JavaScript, through inclusion in the HTML.

The change would look similar to this PR, it would be likely smaller:

• feat: add ability to control mermaid icon packs #7929

Currently your suggestion gets the same response:

We are currently in feature freeze, because we're putting all of our efforts into very important foundational work. Once that's done, we might consider adding this functionality.

So if you need the feature ASAP, then the hack would be a quick solution, or you have to fork and maintain your own custom theme.

[Explorer-Dong]

Thanks for your suggestions, looking forward to your future versions.