Skip to content

Commit

Permalink
Set GitHub Pages release version
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions Bot committed Nov 30, 2024
1 parent 74b2d5a commit 0850451
Show file tree
Hide file tree
Showing 380 changed files with 201,215 additions and 4 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ _pkginfo.txt
/bld/
/bin/
/BundleArtifacts/
/dist/
/archives/*.zim*
/archives/*wikivoyage*.zim
/archives/*medicine*.zim
Expand Down
1,122 changes: 1,122 additions & 0 deletions dist/CHANGELOG.md

Large diffs are not rendered by default.

336 changes: 336 additions & 0 deletions dist/KiwixWebApp-github.jsproj

Large diffs are not rendered by default.

337 changes: 337 additions & 0 deletions dist/KiwixWebApp.jsproj

Large diffs are not rendered by default.

674 changes: 674 additions & 0 deletions dist/LICENSE

Large diffs are not rendered by default.

404 changes: 404 additions & 0 deletions dist/Package.StoreAssociation.xml

Large diffs are not rendered by default.

232 changes: 232 additions & 0 deletions dist/README.md

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions dist/archives/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## If you are viewing this folder on GitHub or a cloned repository…

Due to GitHub filesize restrictions, it is not possible to upload ZIMs that are larger than 100Mb to this directory. If you wish to build the source code yourself,
you will need to add the appropriate packaged ZIM file to your local repository before building, or else commit a
[split ZIM archive](https://github.com/kiwix/kiwix-js-pwa/tree/main/AppPackages#download-a-zim-archive-all-platforms) in chunks ideally below 50MB each chunk.

## How to change the packaged archive

If you have a distribution of this app and want to delete the packaged archive to save space, or change the default archive, simply delete the ZIM file here or add your own file and change some values in the `www/js/init.js`. The values to change are these:

```
params['packagedFile'] = "name_of_your_file.zim";
params['fileVersion'] = "descriptive_name_of_your_file (Jan-2020)"; // These values will show in the app
params['cachedStartPages'] = false;
params['kiwixDownloadLink'] = "https://download.kiwix.org/zim/"; //Include final slash
```

You can have more than one ZIM archive in `archives`, but only one will launch on app startup as the packaged file. If you do have more than one, then be sure to set `params['showFileSelectors'] = true;` to aid in discoverability of the other archive, otherwise your users will not easily realize it is there. Keeping that parameter as `false` dedicates the app to the packaged archive, but users can still override and pick a different ZIM by changing the value in Expert Settings (Config).

## Building the app

If you are building a custom packaged version of the app, then remember that ZIMs will not appear in your online GitHub repo, so add a text file to `archives` to show the intended filename, like the `*.zim.txt` file in this directory, e.g. `wikivoyage_en_all_novid_2019-07.zim.txt`. The text file can be empty (0 bytes). You should also set the fields listed above in `www/js/init.js` to match, and additionally decide whether to set `params['showFileSelectors'] = false;` (if you want to simplify the interface in Config).

Advanced: If you wish to restrict the files that users can search for on the server, e.g. to ensure your app remains dedicated to WikiMed archives, and to aid discoverability of only those archives, then look in `kiwixServe.js` and search for `DEV:` (first comment labelled `DEV:`) for more info. Also, ensure `params['kiwixDownloadLink'] = "https://download.kiwix.org/zim/";` is set appropriately so that the download library opens in the directory where multilingual or updated versions of your packaged ZIM can be found.
Binary file added dist/images/2000px-Kiwix_logo_v3.svg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/2000px-Kiwix_logo_v3_with_border.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/BadgeLogo.scale-100.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/BadgeLogo.scale-125.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/BadgeLogo.scale-150.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/BadgeLogo.scale-200.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/BadgeLogo.scale-400.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/EdgeChromium.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/KiwixLogoVerticalHero_v3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
591 changes: 591 additions & 0 deletions dist/images/KiwixLogoVertical_v2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/KiwixLogoVertical_v2.svg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/KiwixLogoVertical_v3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
614 changes: 614 additions & 0 deletions dist/images/KiwixLogoVertical_v3.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/KiwixLogoVertical_v3_440.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/KiwixLogoVertical_v3_440x280.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/KiwixLogoVertical_v3_store.svg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/KiwixLogoVertical_v3_white.svg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
71 changes: 71 additions & 0 deletions dist/images/Kiwix_icon_transparent.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dist/images/Kiwix_logo_v3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions dist/images/Kiwix_logo_v3.svg
Binary file added dist/images/Kiwix_logo_v3_2048.png
Binary file added dist/images/Kiwix_logo_v3_2048_store_template.png
Binary file added dist/images/Kiwix_logo_v3_300.png
Binary file added dist/images/Kiwix_logo_v3_300_midnight_blue.png
Binary file added dist/images/Kiwix_logo_v3_navy.png
Binary file added dist/images/Kiwix_logo_v3_navy_drawing.png
Binary file added dist/images/Kiwix_logo_v3_no_trans.png
Binary file added dist/images/Kiwix_logo_v3_no_trans_512.png
Binary file added dist/images/Kiwix_logo_v3_outline.png
Binary file added dist/images/Kiwix_logo_v3_outline_trans.png
Binary file added dist/images/Kiwix_logo_v3_outline_trans_blue.png
Binary file added dist/images/Kiwix_logo_v3_store_150.png
Binary file added dist/images/Kiwix_logo_v3_store_2160.png
Binary file added dist/images/Kiwix_logo_v3_store_300.png
Binary file added dist/images/Kiwix_logo_v3_store_71.png
Binary file added dist/images/LargeTile.scale-100.png
Binary file added dist/images/LargeTile.scale-125.png
Binary file added dist/images/LargeTile.scale-150.png
Binary file added dist/images/LargeTile.scale-200.png
Binary file added dist/images/LargeTile.scale-400.png
Binary file added dist/images/SmallTile.scale-100.png
Binary file added dist/images/SmallTile.scale-125.png
Binary file added dist/images/SmallTile.scale-150.png
Binary file added dist/images/SmallTile.scale-200.png
Binary file added dist/images/SmallTile.scale-400.png
Binary file added dist/images/Square150x150Logo.scale-100.png
Binary file added dist/images/Square150x150Logo.scale-125.png
Binary file added dist/images/Square150x150Logo.scale-150.png
Binary file added dist/images/Square150x150Logo.scale-200.png
Binary file added dist/images/Square150x150Logo.scale-400.png
Binary file added dist/images/Square44x44Logo.scale-100.png
Binary file added dist/images/Square44x44Logo.scale-125.png
Binary file added dist/images/Square44x44Logo.scale-150.png
Binary file added dist/images/Square44x44Logo.scale-200.png
Binary file added dist/images/Square44x44Logo.scale-400.png
Binary file added dist/images/Square44x44Logo.targetsize-16.png
Binary file added dist/images/Square44x44Logo.targetsize-24.png
Binary file added dist/images/Square44x44Logo.targetsize-256.png
Binary file added dist/images/Square44x44Logo.targetsize-32.png
Binary file added dist/images/Square44x44Logo.targetsize-48.png
Binary file added dist/images/Wide310x150Logo.scale-100.png
Binary file added dist/images/Wide310x150Logo.scale-125.png
Binary file added dist/images/Wide310x150Logo.scale-150.png
Binary file added dist/images/Wide310x150Logo.scale-200.png
Binary file added dist/images/Wide310x150Logo.scale-400.png
Binary file added dist/images/WikiMed_400x430.png
Binary file added dist/images/Wikivoyage_400x400_colour_pop.png
1 change: 1 addition & 0 deletions dist/images/edgelegacy-color.svg
1 change: 1 addition & 0 deletions dist/images/electron-color.svg
Loading

0 comments on commit 0850451

Please sign in to comment.