@quartz-community/search 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Listen for `content-index-updated` `CustomEvent` dispatches and incrementally add the new entries to the FlexSearch index. This enables runtime extension of the search index by other plugins — in particular `@quartz-community/encrypted-pages`, which patches the in-memory content index with newly-decrypted unlisted pages and dispatches this event so the user can find and open those pages via search within the same browser session.
+
+- Initial Quartz community plugin template.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Quartz Community
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,113 @@
+# @quartz-community/search
+
+The Search component for Quartz - full-text search with FlexSearch integration.
+
+## Features
+
+- 🔍 **Full-Text Search** - Search across all your content instantly
+- ⚡ **Fast Indexing** - Uses FlexSearch for high-performance search
+- 📱 **Mobile Responsive** - Works great on all devices
+- 🎯 **Search Preview** - Optional content preview panel
+- 🌐 **Multi-Language** - Supports 30+ locales
+- ⌨️ **Keyboard Shortcuts** - `Ctrl/Cmd + K` to open, `Escape` to close
+- 🏷️ **Tag Search** - Search by tags with special syntax
+
+## Installation
+
+```bash
+npx quartz plugin add github:quartz-community/search
+```
+
+## Usage
+
+```yaml title="quartz.config.yaml"
+plugins:
+  - source: github:quartz-community/search
+    enabled: true
+    layout:
+      position: left
+      priority: 20
+      group: toolbar
+      groupOptions:
+        grow: true
+```
+
+For advanced use cases, you can override in TypeScript:
+
+```ts title="quartz.ts (override)"
+import * as ExternalPlugin from "./.quartz/plugins";
+
+ExternalPlugin.Search({
+  enablePreview: true,
+  placeholder: "Search for something",
+  title: "Search",
+});
+```
+
+## Configuration Options
+
+```typescript
+interface SearchOptions {
+  /** Enable content preview panel */
+  enablePreview?: boolean;
+  /** Custom placeholder text */
+  placeholder?: string;
+  /** Custom title for the search button */
+  title?: string;
+}
+```
+
+## Default Behavior
+
+By default, the search component:
+
+- Displays as a button with a search icon
+- Opens a fullscreen search modal when clicked
+- Shows up to 8 search results
+- Enables content preview on desktop (can be disabled)
+- Supports keyboard navigation (arrow keys, Enter, Escape)
+- Uses FlexSearch from CDN for indexing
+
+## How It Works
+
+The Search component:
+
+1. Loads FlexSearch library from CDN when initialized
+2. Fetches content data via the `fetchData` global (resolves `contentIndex.json` with the correct base path)
+3. Builds a search index from your content
+4. Performs real-time search as you type
+5. Shows results with optional content preview
+
+> [!info]
+> Search requires the `ContentIndex` emitter plugin to be present in your Quartz configuration.
+
+## Keyboard Shortcuts
+
+- `Ctrl/Cmd + K` - Open/Close search
+- `Escape` - Close search
+- `Arrow Up/Down` - Navigate results
+- `Enter` - Open selected result
+
+## Development
+
+This is a first-party Quartz community plugin. It serves as both:
+
+1. A production-ready Search component
+2. A reference implementation for building Quartz community plugins
+
+To build locally:
+
+```bash
+npm install
+npm run build
+```
+
+The `prepare` script automatically builds during installation.
+
+## Documentation
+
+See the [Quartz documentation](https://quartz.jzhao.xyz/features/full-text%20search) for more information.
+
+## License
+
+MIT

package/dist/components/index.d.ts

@@ -0,0 +1,2 @@
+export { Search, SearchField, SearchOptions } from '../index.js';
+import '@quartz-community/types';