Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make search_index a JSON file #2516

Open
aaruni96 opened this issue May 31, 2024 · 0 comments
Open

Make search_index a JSON file #2516

aaruni96 opened this issue May 31, 2024 · 0 comments
Labels
Format: HTML Related to the default HTML output Status: Speculative It's unknown if this is something that we wan't to do

Comments

@aaruni96
Copy link
Contributor

Right now, search_index is a javascript file, who's only purpose is to assign the index to a variable called "documenterSearchIndex". Instead, it could be a valid JSON file, and we could load it into the variable from within assets/html/js/search.js. The end result would behave the same way, with the added benefit that projects using Documenter could manipulate the index json to permanently change results, instead of trying to patch the the final documenter.js to add more filters to do at search time.

I can submit a PR for this in a bit.

@mortenpi mortenpi added Status: Speculative It's unknown if this is something that we wan't to do Format: HTML Related to the default HTML output labels Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output Status: Speculative It's unknown if this is something that we wan't to do
Projects
None yet
Development

No branches or pull requests

2 participants