kiwix/kiwix-desktop
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-desktop.git synced 2025-08-03 12:46:29 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add instructions to debug ZIM rendering

Browse Source
This commit is contained in:
benoit74 2025-07-17 13:20:59 +00:00
parent eeb78333ad
commit dbc99ccfcb
No known key found for this signature in database
GPG Key ID: B89606434FC7B530
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -139,6 +139,18 @@ environment variable:
LD_LIBRARY_PATH="<...>/BUILD_native_dyn/INSTALL/lib/x86_64-linux-gnu"
```
Debug a specific ZIM
---
`kiwix-desktop` uses **Qt WebEngine** to render ZIM content, relying on a custom `zim:` protocol to expose the ZIM data to the WebEngine.
To debug issues related to WebEngine, follow these steps:
1. Launch `kiwix-desktop` with the environment variable `QTWEBENGINE_REMOTE_DEBUGGING=<port>` set (replace `<port>` with an available local port number).
2. Open the desired ZIM file in the `kiwix-desktop` user interface.
3. In a Chromium-based browser, go to: `http://localhost:<port>`.
4. This opens the remote debugging UI. Use it to access Chrome DevTools connected to the ZIM webpage rendered by WebEngine.
## Communication
Available communication channels: