Important
Documentation Status: Text content is complete! Screenshot placeholders (📸) will be replaced with actual images soon.
Welcome to the comprehensive documentation for Find-n-Replace, a VSCode-style vault-wide search and replace plugin for Obsidian.
-
User Guide - Complete step-by-step guide with screenshots
- Getting started with your first search
- Understanding the interface
- Basic and advanced features
- Settings configuration
-
Workflows - Real-world usage scenarios
- Refactoring links across your vault
- Cleaning up task formatting
- Finding and fixing broken links
- Bulk date format updates
- Content organization
-
Tips & Tricks - Power user features
- Performance optimization techniques
- Keyboard shortcut mastery
- Advanced regex patterns
- Workflow automation
- Common pitfalls to avoid
New to Find-n-Replace? Start here:
- Installation - Get the plugin installed
- Your First Search - Learn the basics in 5 minutes
- Common Workflows - See real-world examples
The main README provides:
- Feature overview and capabilities
- Installation instructions
- Configuration reference
- Technical architecture details
- Developer guidelines
- Find content across my vault → Basic Search
- Replace text in multiple files → Replacement Operations
- Use regex patterns → Regex Guide
- Filter by file type or folder → File Filtering
- Search across multiple lines → Multiline Search
- Select specific matches → Multi-Selection
- Navigate search history → Search History
- Configure settings → Settings Guide
- Optimize performance → Performance Tips
- Learn keyboard shortcuts → Keyboard Navigation
- Convert date formats → Date Format Workflow
- Update links → Link Refactoring Workflow
- Clean up formatting → Formatting Cleanup Workflow
- Find broken links → Link Validation Workflow
- Organize content → Content Organization Workflow
- No search results → Troubleshooting Search
- Slow searches → Performance Optimization
- Regex not working → Regex Troubleshooting
- Selection issues → Selection Tips
All guides include screenshot placeholders showing:
- Interface elements - Annotated UI components
- Step-by-step workflows - Numbered sequences
- Before/after comparisons - Visual results
- Feature demonstrations - Interactive examples
Note: Screenshots will be added following the Screenshot Guide specifications.
- User Guide: ~800 lines, 14 screenshot references
- Workflows: ~600 lines, 15 step-by-step examples
- Tips & Tricks: ~400 lines, 8 illustrated techniques
- Total Coverage: 37 visual examples with detailed explanations
- GitHub Repository: gapmiss/find-n-replace
- Obsidian Plugin Directory: Find-n-Replace
- Issue Tracker: Report bugs or request features
- Discussions: Community support
This documentation corresponds to Find-n-Replace v1.0.0
Last updated: 2025-11-12
Need help? Start with the User Guide or jump to a specific workflow that matches your needs.