Gatsby: API reference pages not indexed in site search

[gillkyle]

One user on Discord noted that they found it hard to find docs for createRedirect, upon investigation realized that the search on the site doesn't pick up any of the API's from the references page. This seems to be because Algolia picks up elements with the docSearch class applied, this happens automatically for a lot of content on the site that's built from .md files, but pages like the reference page linked to above don't explicitly add that class.

One of two options could be done to resolve this:

• change https://github.com/algolia/docsearch-configs/blob/master/configs/gatsbyjs.json which defines how content is indexed on the site
• adjust the template files to match the classes defined in that gatsby.json file on algolia's repo so that they _do_ get indexed and can be searched for

[gatsbot[bot]]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.

If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!

As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

[n8finch]

@gillkyle could I grab this one? If it's still up for grabs?

[gillkyle]

Hey @n8finch sorry to get back to you so late, I see you self-assigned the issue and you are welcome to jump in and try and figure things out!

[fk]

👍 Maybe we should add a bit of documentation (CSS class, point to the Algolia docsearch config) to www/README.md? (or the component that handles docsearch, although that might be too deep in the code)

[n8finch]

@fk and @gillkyle I can definitely add this to the README.md, do you want anything other than a new section that says:

1. When you're adding something that needs to be indexed, make sure you add the docSearch-content class to the section.
2. This is probably using the <Layout> or <Container> component to wrap the searchable content.

Anything else?

[fk]

Hey Nate! Thanks you so much! 🤗 🙏

Anything else?

A reference to Gatsby's docsearch configuration at https://github.com/algolia/docsearch-configs/blob/master/configs/gatsbyjs.json would be 💯