rust-lang / mdBook

Create book from markdown files. Like Gitbook but implemented in Rust
https://rust-lang.github.io/mdBook/
Mozilla Public License 2.0
18.4k stars 1.65k forks source link

If `!search_config.copy_js`, then perform useless search indexing, and search is disabled #2403

Open SichangHe opened 5 months ago

SichangHe commented 5 months ago

Problem

https://github.com/rust-lang/mdBook/blob/3bdcc0a5a6f3c85dd751350774261dbc357b02bd/src/renderer/html_handlebars/search.rs#L42-L54

Here, if !search_config.copy_js, then index is not used, so the above expensive computation is wasted.

More importantly, since the search index is not written, the search feature does not work. That is, search is only enabled if search_config.enable && search_config.copy_js, instead of the intended behavior of just depending on search_config.enable.

Steps

N/A

Possible Solution(s)

The name copy_js seems to suggest the use of a CDN if set to false, however, looking at https://github.com/rust-lang/mdBook/blob/3bdcc0a5a6f3c85dd751350774261dbc357b02bd/src/theme/index.hbs#L311, the links to a CDN seems to be missing. If so, then the solution would be:

  1. Add the CDN links of the search JS to the index.hbs file and enable them when search_config.enable && !search_config.copy_js.
  2. Correct create_files to write the index JSON file when !search_config.copy_js.

However, if !search_config.copy_js disabling the search entirely is the intended behavior (which would be weird), then maybe we should just get rid of it and fully rely on search_config.enable.

Notes

Additionally, the search index is unnecessarily duplicated in both searchindex.json and searchindex.js, which are sequentially tentatively queried by searcher.js.

Version

Please see the permalink above pointing to the latest master as of this writing.