Allow portions of documents to be excluded from search index

[nickvigilante]

Welcome to the quarto GitHub repo!

We are always happy to hear feedback from our users.

To file a pull request, please follow these instructions carefully: https://yihui.org/issue/#bug-reports

If you're a collaborator from outside quarto-dev making changes larger than a typo, please make sure you have filed an individual or corporate contributor agreement. You can send the signed copy to [email protected].

Also, please complete and keep the checklist below.

Description

This PR adds a class, quarto-exclude-from-search-index, that you can add to any div or span to exclude the content from that section from Quarto's search index (search.json). This PR fixes #11189.

Checklist

I have (if applicable):

• filed a contributor agreement.
• referenced the GitHub issue this PR closes
• updated the appropriate changelog

[cscheid]

Thanks!

Let's talk about the class you're using. I would prefer that we used a class starting with quarto-, something likequarto-exclude-from-search-index. It is admittedly verbose, but this is a feature that has the potential to be quite confusing for users if they're unaware, and a quarto- prefix minimizes the change that some existing document already has a class like that. (You can always retarget your preferred classes to quarto-exclude-from-search-index in a Lua filter)

In addition to the CLA signature and the changelog entry, we will need a few more things:

1. Tests of course need to all pass.
2. This is a new feature, so we need an accompanying documentation PR against the prerelease branch of https://github.com/quarto-dev/quarto-web/
3. Tests. Probably the easiest way to do it is to add a test that

• renders a full project with the a div that excludes a unique word, and then check that the word is missing from the search.json file.
• renders the same project with a project profile that adds a filter to remove the class, and then check that word is present in the corresponding search.json file.

[nickvigilante]

The class is now renamed to quarto-exclude-from-search-index. CLA is underway. I contacted the head of ops at TileDB for a review, and I'm also trying to identify other members of my company who may want to contribute to this repo in the future. In response to your other feedback:

1. Understood, and I'm now testing different variations locally. My TypeScript is rusty, but it'll get there 😄
2. Once I get this working, I'll start work on a docs update.
3. I'll work on tests as well.

[cscheid]

The class is now renamed to quarto-exclude-from-search-index.

Just FYI, I don't think you've pushed this yet.

[nickvigilante]

Correct, I haven't. I'm still testing locally.

[cscheid]

@nickvigilante I was in the process of fixing a separate search index bug, and so I made a PR that includes a test that you should be able to adapt for this one. Take a look at #11191

[nickvigilante]

@cscheid Hey Carlos, sorry I dropped the ball on this. I was scrambling to get stuff done before year end.

I'm trying to get this final smoke test to pass, and I keep hitting an error. Do you have any pointers on how to overcome this?

[cderv]

@nickvigilante did you try to run your test locally ? This is easier to debug and check that eveyrhing works as you expect.
Do they passe locally for you ?

You could try

quarto render --profile with-filter docs/search/issue-11189

Also try in your test

const withFilterProfile = ["--profile", "with-filter"]

and

testQuartoCmd(
  "render",
  [input, ...withFilterProfile]

so that each args is passed separately and --profile flag correctly identified (and not seen as '--profile with-filter')

You can also use run-test.sh locally if you have test environment setup in dev version.

Hope it helps