Files
quartz/docs/plugins/Search.md
saberzero1 05b79e1d60 docs: add missing options to component and page type plugin documentation
- Graph: add focusOnHover and numeric defaults for all D3Config options
- Search: add enablePreview and fieldPriority options
- TableOfContents: add layout component option
- FolderPage: add showFolderCount and showSubfolders options
- TagPage: add numPages option
- BasesPage: add linkResolution option
2026-05-22 20:07:48 +02:00

41 lines
1.0 KiB
Markdown

---
title: Search
tags:
- plugin/component
image: https://images.unsplash.com/photo-1516382799247-87df95d790b7
---
Full-text search functionality.
> [!note]
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
See [[full-text search]] for detailed usage information.
## Configuration
This plugin accepts the following configuration options:
- `enablePreview`: Whether to show a preview of the page content in search results. Defaults to `true`.
- `fieldPriority`: An array specifying the priority order for search fields. Defaults to `["title", "content", "tags"]`.
### Default options
```yaml title="quartz.config.yaml"
- source: github:quartz-community/search
enabled: true
options:
enablePreview: true
fieldPriority:
- title
- content
- tags
```
## API
- Category: Component
- Function name: `ExternalPlugin.Search()`.
- Source: [`quartz-community/search`](https://github.com/quartz-community/search)
- Install: `npx quartz plugin add github:quartz-community/search`