kiwix/kiwix-apple-custom
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-apple-custom.git synced 2025-09-22 11:51:04 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update Readme

Browse Source
This commit is contained in:
Balazs Perlaki-Horvath 2025-04-26 19:56:54 +02:00
parent 1f5755214f
commit 5c3d0ef459
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -55,6 +55,8 @@ These key / values can be, but do not need to be included in the `info.json` fil
- `disable_immersive_reading` - optional (true| false) - if set to true, it will disable the immersive reading functionality on iOS, which is hiding the top / bottom nav bars while scrolling the web content. If the ZIM content is specific to a full screen experience (eg: PhET) it might be better to turn this feature off, so that the user navigation is not blocked (eg navigating back, search, bookmarks ect).
- `hide_random_button` - optional (true | false) - if set to true, it will hide the random article button in the navigation bar and on macOS within the right click context menu. By default (if omitted) it's false.
- `zim_auth` - (optional) this is needed if standard http authentication is required to download the ZIM file. This should be set to **an environment variable name**, which will be resolved during build time. Make sure that the environment variable itself is set up properly before running the build process. **Do not place any credentials directly here, it's not safe, and won't work.**
## XCAssets file