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

Search inside the documentation doesn't work well #2821

Open
82MHz opened this issue Mar 12, 2025 · 3 comments
Open

Search inside the documentation doesn't work well #2821

82MHz opened this issue Mar 12, 2025 · 3 comments

Comments

@82MHz
Copy link

82MHz commented Mar 12, 2025

Documentation issue

Summary

What is the issue? Is the documentation unclear? Is it missing information?

The documentation on getzola.org has a search field on the top, but the search does not find things that are in the documentation.

As an example, this page mentions the variables word_count and reading_time. But entering these exact terms in the search box turns up nothing, even though they're right there on the page. This is very frustrating because I often know that I read something in the documentation, but I have to click through many pages of it until I find it again because searching doesn't work.

Proposed solution

The search inside the documentation should reliably turn up expressions that are mentioned in the documentation.

@Keats
Copy link
Collaborator

Keats commented Mar 14, 2025

That's because the code blocks are ignored for the search index generation, it was causing a lot of bloat for many sites.

@Raymi306
Copy link
Contributor

Could this feature be opt-in?

@Keats
Copy link
Collaborator

Keats commented Mar 23, 2025

It could be, it's just that the code block generate an awful amount of content in the search index so it's pretty hard to use in practice since the index file gets huge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants