MarathonLabs / marathon

Cross-platform test runner
https://docs.marathonlabs.io
GNU General Public License v2.0
584 stars 121 forks source link

Docs: Make text in code blocks searchable #763

Open VictorIreri opened 1 year ago

VictorIreri commented 1 year ago

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

grine4ka commented 3 weeks ago

There was an issue in docasaurus and docsearch: https://github.com/facebook/docusaurus/issues/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