Support
Need help with Live Highlighter? Here's how to get assistance.
Documentation
Before seeking support, check if your question is answered in our documentation:
- Quick Start Guide - Get started quickly
- Creating Rules - Learn about highlight rules
- Managing Rules - Organize and maintain rules
- FAQ - Frequently asked questions
- Compatibility - Browser and platform support
Reporting Bugs
Found a bug? Please report it on GitHub:
- Go to our GitHub Issues page
- Search existing issues to see if it's already reported
- If not found, click "New Issue"
- Choose "Bug Report" template
- Provide as much detail as possible:
- Browser and version
- Operating system
- Steps to reproduce the bug
- Expected behavior
- Actual behavior
- Screenshots (if applicable)
What Makes a Good Bug Report
Good Example:
**Browser:** Chrome 120.0.6099.109
**OS:** Windows 11
**Steps to reproduce:**
1. Create a rule for "test" with red highlight
2. Navigate to example.com
3. The word "test" appears but is not highlighted
**Expected:** The word should be highlighted in red
**Actual:** No highlighting appears
**Screenshot:** [attached]
Not Helpful:
Feature Requests
Have an idea for a new feature? We'd love to hear it!
- Go to our GitHub Issues page
- Search existing issues to see if it's already suggested
- If not found, click "New Issue"
- Choose "Feature Request" template
- Describe:
- The feature you'd like
- Why it would be useful
- How it should work
- Any examples or mockups
Popular Feature Requests
Check if your idea is already on our radar:
- Website-specific rules
- Import/export functionality
- Regular expression support
- Cross-device sync
- Firefox and Safari support
Community
Discussions
For general questions, ideas, or discussions:
- GitHub Discussions (coming soon)
- Community forums (coming soon)
Social Media
Stay updated on Live Highlighter news:
- GitHub: @cromtech-labs
- Project updates in release notes
Contributing
Want to contribute to Live Highlighter?
- Visit our GitHub repository
- Read the contributing guidelines
- Fork the repository
- Make your changes
- Submit a pull request
All contributions are welcome, including:
- Code improvements
- Bug fixes
- Documentation updates
- Translations (future)
- Design improvements
Getting Help
Before Asking for Help
- Check the FAQ
- Search existing GitHub issues
- Try the troubleshooting steps in the relevant documentation
How to Ask for Help
When asking for help, please provide:
- What you're trying to do
- What you've tried so far
- Browser and version
- Operating system
- Screenshots or error messages (if applicable)
- Steps you've taken to troubleshoot
Response Time
Live Highlighter is an open-source project. Response times vary, but we try to:
- Acknowledge issues within 48 hours
- Respond to questions within a week
- Fix critical bugs as quickly as possible
Commercial Support
Live Highlighter is a free, open-source project. Commercial support is not currently available.
If your organization needs custom features or dedicated support, you can:
- Fork the repository and modify it for your needs (MIT License)
- Hire a developer to customize it
- Contact the maintainers to discuss custom development
Security Issues
Found a security vulnerability? Please do not open a public issue.
Instead:
- Email the maintainers (contact info in GitHub profile)
- Provide details about the vulnerability
- Allow time for a fix before public disclosure
We take security seriously and will respond quickly to security reports.
Feedback
We're actively seeking feedback to improve Live Highlighter. Even if you don't have a specific bug or feature request, we'd love to hear:
- How you're using Live Highlighter
- What works well
- What could be better
- Ideas for improvement
Share your feedback:
- GitHub Issues (tagged as "feedback")
- GitHub Discussions (when available)
Thank You
Thank you for using Live Highlighter! Your feedback and support help make the extension better for everyone.