Merged
Conversation
This commit introduces a directory-level search functionality to Markon. Users can enable this feature by using the `--enable-search` flag when running the application. When enabled, Markon will index all Markdown files in the current directory and its subdirectories. The frontend has been updated with a search modal that can be triggered by pressing the `/` key or by clicking the "Search" link in the footer. The search results are displayed in real-time as the user types. The backend has been updated with a new `/search` endpoint that queries the search index and returns the results in JSON format. The search index is created in-memory using SQLite and the FTS5 extension.
Contributor
Author
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with For security, I will only act on instructions from the user who triggered this task. New to Jules? Learn more at jules.google/docs. |
This commit enhances the directory-level search functionality by adding a file watcher that automatically updates the search index when files are created, modified, or deleted. The search logic has been refactored into a separate `src/search.rs` module for better code organization and maintainability. A new `watch_files_for_changes` function has been implemented using the `notify` crate to monitor file system events. This function runs in a background task and updates the search index in real-time. A debounce mechanism has been added to prevent excessive updates when multiple file events are triggered in a short period.
… suggestions - Introduce ServerConfig struct to reduce start() function arguments from 8 to 1 - Replace map_or with is_some_and for cleaner extension checks - Remove unnecessary borrows in rusqlite execute calls - Run cargo fmt to fix formatting issues
kookyleo
force-pushed
the
feature/directory-search
branch
from
5bc5808 to
685297c
Compare
- Upgrade to tantivy 0.25 and tantivy-jieba 0.17 - Implement full-text search with Chinese word segmentation (jieba) - Create in-memory search index for markdown files - Add file watcher for automatic index updates - Support multi-field search (filename, title, content) - Generate highlighted snippets in search results - Keep rusqlite only for shared annotations feature
…nality - Add 11 unit tests in src/search.rs covering: * Index creation and basic search * Chinese word segmentation with jieba * Multi-field search (file_name, title, content) * File update and deletion * Snippet generation * Title extraction * Search limit functionality * Empty queries and non-markdown files - Add 13 integration tests in tests/search_integration_test.rs: * Directory structure traversal * Chinese content search * Mixed language search * File update/deletion workflows * Concurrent searches * Large file indexing * Special characters handling * Empty directory handling - Fix critical bugs: * Change path field from STORED to STRING | STORED for deletions * Add reader.reload() after commits for visibility * Fix update_file to delete and add in same transaction * Make SearchResult fields public for testing - Add tempfile dev dependency for test fixtures - Create src/lib.rs to expose modules for integration tests
- Create dedicated 'Search (when enabled)' category - Add visibility check for search shortcuts similar to Viewed - Remove search shortcut from Core category for better organization
UI Improvements: - Modern modal design with backdrop blur and rounded corners - Better spacing and typography for search results - Display result title, file path, and snippet separately - Monospace font for file paths - Smooth transitions and animations - Theme-aware styling (light/dark/auto) Keyboard Navigation: - Up/Down arrow keys to navigate results - Enter key to select current result - Mouse hover updates selection - Auto-scroll selected item into view - Click overlay to close modal Visual Enhancements: - Selected item has left border accent and subtle transform - Highlighted search terms in snippets - Improved contrast and readability - Max height for results with scroll - Better empty state message
Problem: - Search results used absolute file paths (e.g., /tmp/xxx/file.md) - Clicking search results navigated to incorrect URLs Solution: - Store start_dir in SearchIndex struct - Calculate relative paths using strip_prefix() when indexing - Apply same logic in index_file(), update_file(), and delete_file() - Search results now use paths relative to start_dir Testing: - All 11 unit tests pass - Paths are now relative (e.g., docs/guide.md instead of /full/path/docs/guide.md)
Features: - Click search result navigates to exact match location - Matched keywords are highlighted in the document - Auto-scroll to first match with smooth animation - Temporary pulse animation on highlighted text (3 seconds) Implementation: - Add 'highlight' query parameter to search result URLs - New HighlightManager to find and highlight text matches - Smart text node traversal using TreeWalker - Multi-word query support with individual highlighting - Theme-aware highlighting colors (yellow/amber) UI/UX: - Smooth scroll to first match (center alignment) - Pulse animation (3 iterations, 0.6s each) - Yellow background for matches, amber for active match - Fade out after 3 seconds - Print-friendly (no highlights in print mode) Technical: - Split query into words for better matching - Case-insensitive search - Skip script/style tags and existing highlights - Safe DOM manipulation with fragment replacement - Works independently of search feature (can use URL directly)
Design Changes: - Full-screen modal (100% width/height) with solid background - Remove semi-transparent blur backdrop - Remove rounded corners and centered card layout - Use entire viewport space without scrollbars on container Layout: - Flexbox column layout (input at top, results fill remaining) - Search input: larger padding (32px 48px), bigger font (1.4em) - Results list: flex-grow to fill space, scrollable when needed - Result items: increased padding (24px 48px) for better readability Visual Improvements: - Input has subtle background color different from results area - Thicker bottom border (2px) on search input - Cleaner separation between items with minimal borders - Selected item uses left border accent (3px solid) - Larger text sizes throughout (title 1.1em, snippet 0.95em) Interaction: - Remove click-overlay-to-close (ESC only) - Full-screen immersive search experience - Better focus on search results Theme Support: - Light: white background (#ffffff) with gray input (#f6f8fa) - Dark: dark background (#0d1117) with darker input (#161b22) - Auto: responds to system preference
Fixes: - Increase z-index from 1000 to 10000 to overlay all elements - Reduce excessive spacing for better content density Spacing adjustments: - Search input: 16px 24px (was 32px 48px) - Search input font: 1.1em (was 1.4em) - Result item padding: 12px 24px (was 24px 48px) - Title font: 0.95em (was 1.1em) - Path font: 0.8em (was 0.9em) - Snippet font: 0.85em (was 0.95em) - No results padding: 40px 24px (was 80px 48px) Benefits: - More search results visible without scrolling - Better space utilization - Maintains readability with appropriate font sizes - Modal now properly overlays TOC and other UI elements
Layout improvements: - Constrain search input and results to 980px max-width (same as article) - Keep border and background full-width for visual consistency - Center content using flexbox containers - Match article padding (45px on desktop, 20px on mobile) HTML structure changes: - Add search-input-container wrapper for border management - Add search-results-container for centered results - Separate styling for container (full-width) vs content (constrained) Autocomplete disabled: - Add autocomplete="off" to prevent browser suggestions - Add autocorrect="off" to disable auto-correction - Add autocapitalize="off" to prevent auto-capitalization - Add spellcheck="false" to disable spell checking Visual result: - Search UI now respects article content width - Full-width separator line under search input - Clean, uncluttered search experience - No browser interference with search suggestions
Issue: - 'Keyboard Shortcuts (?)' link was only shown when search is enabled - This prevented users from accessing shortcuts help without --enable-search Fix: - Move keyboard shortcuts link outside of enable_search condition - Keep search link inside the condition (only show when enabled) - Apply same fix to both layout.html and directory.html Result: - Users can always access keyboard shortcuts help via footer link - Equivalent to pressing '?' key - Independent of search feature availability
- Replace len() >= 1 with !is_empty() for clarity - Apply cargo fmt formatting to all test code - Fix line length and formatting issues
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements full-text search functionality for directory-level Markdown browsing with advanced features including Chinese word segmentation, auto-scroll to matched text, and modern UI design.
Fixes #17
Features
Search Engine
File Watching
User Experience
/) - Quick access to searchUI Improvements
Testing
Technical Details
Dependencies
tantivy = "0.25"- Search enginetantivy-jieba = "0.17"- Chinese tokenizernotify = "6.1.1"- File watcherwalkdir = "2.5.0"- Directory traversaltempfile = "3.17"(dev) - Test fixturesKey Files
src/search.rs- Search index implementation (299 lines)src/lib.rs- Module exports for testingassets/js/managers/search-manager.js- Frontend search UIassets/js/managers/highlight-manager.js- Text highlightingtests/search_integration_test.rs- Integration testsArchitecture
Usage
Enable search functionality:
Or for specific file:
Keyboard Shortcuts
/- Open search↑/↓- Navigate resultsEnter- Select resultESC- Close search?- View all shortcutsBreaking Changes
None. Search is opt-in via
--enable-searchflag.Recent Updates
Latest Commits