Troubleshooting
Quick Lookup
Common issues and where to look for the fix:
| Symptom | Likely cause | Where to look |
|---|---|---|
| MCP client can't connect | Stale port file or VMark not running | MCP Server Connection Issues |
| File won't open or shows garbled text | Non-UTF-8 encoding or quarantine attribute | File Won't Open |
| AI Genie hangs or returns nothing | Provider misconfigured or CLI not on PATH | AI Genie Not Responding |
| Keyboard shortcut does nothing | Reassigned in Settings or system override | Keyboard Shortcut Not Working |
| Slow editor on large files | Per-tab memory + 10K+ line input lag | Editor Performance |
| Menu still in English after language change | Menu rebuilds on launch | Menu Bar Shows English |
| PDF export incomplete | Image paths or write permissions | Export/Print Issues |
| Slow startup on Windows | WebView2 + antivirus scanning | App Launches Slowly on Windows |
For anything not listed above, see Reporting Bugs.
Log Files
VMark writes log files to help diagnose issues. Logs include warnings and errors from both the Rust backend and the frontend.
Log File Locations
| Platform | Path |
|---|---|
| macOS | ~/Library/Logs/app.vmark/ |
| Windows | %APPDATA%\app.vmark\logs\ |
| Linux | ~/.local/share/app.vmark/logs/ |
Log Levels
| Level | What's Logged | Production | Development |
|---|---|---|---|
| Error | Failures, crashes | Yes | Yes |
| Warn | Recoverable issues, fallbacks | Yes | Yes |
| Info | Milestones, state changes | Yes | Yes |
| Debug | Detailed tracing | No | Yes |
Log Rotation
- Maximum file size: 5 MB
- Rotation: keeps one previous log file
- Old logs are automatically replaced
Reporting Bugs
When reporting a bug, include:
- VMark version — shown in the navbar badge or About dialog
- Operating system — macOS version, Windows build, or Linux distro
- Steps to reproduce — what you did before the issue occurred
- Log file — attach or paste the relevant log entries
Log entries are timestamped and tagged by module (e.g., [HotExit], [MCP Bridge], [Export]), making it easy to find relevant sections.
Finding Relevant Logs
- Open the log directory from the table above
- Open the most recent
.logfile - Search for
ERRORorWARNentries near the time the issue occurred - Copy the relevant lines and include them in your bug report
Common Issues
App Launches Slowly on Windows
VMark is optimized for macOS. On Windows, startup may be slower due to WebView2 initialization. Make sure:
- WebView2 Runtime is up to date
- Antivirus software is not scanning the app data directory in real-time
Menu Bar Shows English After Language Change
If the menu bar stays in English after switching language in Settings, restart VMark. The menu rebuilds on next launch with the saved language.
Terminal Doesn't Accept CJK Punctuation
Fixed in v0.6.5+. Update to the latest version.
MCP Server Connection Issues
The MCP server may fail to start or clients may not connect.
- Ensure VMark is running — the MCP server only starts when the app is open.
- Check that no other process is using the same port. The MCP server writes a port file for client discovery; stale port files from a previous session can cause conflicts. Restart VMark to regenerate it.
- Review the log file for
[MCP Bridge]entries to identify connection errors.
Keyboard Shortcut Not Working
A shortcut may appear unresponsive if it conflicts with another binding or has been customized.
- Open Settings (
Mod + ,) and navigate to the Shortcuts tab to check whether the shortcut has been reassigned. - Look for duplicate bindings — if two actions share the same key combination, only one will fire.
- On macOS, some shortcuts may conflict with system-level bindings (e.g., Mission Control, Spotlight). Check System Settings > Keyboard > Keyboard Shortcuts.
Export/Print Issues
PDF export may hang or produce incomplete output.
- If images are missing in the export, verify that image paths are relative to the document and that the files exist on disk. Absolute URLs and remote images should be accessible.
- Check file permissions on the output directory — VMark needs write access to save the exported file.
- For large documents, export may take longer. Check the log file for
[Export]entries if it appears stuck.
File Won't Open
VMark may refuse to open a file or show garbled content.
- Verify the file has read permissions for your user account.
- VMark expects UTF-8 encoded Markdown. Files in other encodings (e.g., GB2312, Shift-JIS) may not display correctly — convert them to UTF-8 first.
- If the file is locked by another process (e.g., a sync client or backup tool), close that process and try again.
Editor Performance
The editor may slow down with very large files or many open tabs.
- Close unused tabs to free memory — each open tab maintains its own editor state.
- Very large documents (over 10,000 lines) can cause input lag. Consider splitting them into smaller files.
- Disable Focus Mode and Typewriter Mode if not needed, as they add extra rendering overhead.
AI Genie Not Responding
AI Genies require a configured AI provider to function.
- Open Settings and verify that an AI provider (e.g., Ollama, OpenAI, Anthropic) is configured with a valid model name.
- The provider CLI must be available in your PATH. On macOS, GUI apps have a minimal PATH — if the CLI was installed via Homebrew, ensure your shell profile exports the correct path.
- Check the model name for typos. An incorrect model name will silently fail or return an error.