Skip to content

Document search changes from quarto-cli/pulls/11191 #1415

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 24, 2024
Merged

Document search changes from quarto-cli/pulls/11191 #1415

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/websites/website-search.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ website:
tagFilters: ['tag1','tag2']
```

## Disabling Search
## Disabling/Forcing Search

You can disable search for an individual document by adding `search: false` to the document metadata. For example:

Expand All @@ -207,3 +207,8 @@ If you'd like to disable search support for an entire website, you can do so by
website:
search: false
```

### Forcing the inclusion of individual elements

If you need elements from the document to be included in the search that otherwise wouldn't, add the `quarto-include-in-search-index` class to the element.
To include only a portion of a paragraph, etc, wrap the text in a span or a div and add the class to the element.