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

Docs: Make text in code blocks searchable #763

Open
VictorIreri opened this issue Mar 5, 2023 · 1 comment
Open

Docs: Make text in code blocks searchable #763

VictorIreri opened this issue Mar 5, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@VictorIreri
Copy link
Contributor

Searching for text present only in code blocks yields no results.
For example, "uncompletedTestRetryQuota" can't be found because, throughout the docs, it's only present in a code block. I would expect all displayed text in the docs to be searchable.

marathon search no results

@VictorIreri VictorIreri added the enhancement New feature or request label Mar 5, 2023
@grine4ka
Copy link

grine4ka commented Oct 28, 2024

There was an issue in docasaurus and docsearch: facebook/docusaurus#3172
Although docsearch can index code samples, they do not recommend it: https://docsearch.algolia.com/docs/docsearch-program/#can-you-index-code-samples

So, I guess it would be better not to enable searching in code samples, but rather put important parameters out of code blocks in docs

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

No branches or pull requests

2 participants