Difference between revisions of "Build your ZIM file"

Jump to navigation Jump to search
added Zimit and wget-2zim to the "User" section
(added Zimit and wget-2zim to the "User" section)
(2 intermediate revisions by 2 users not shown)
Line 29: Line 29:
=== Create a ZIM file from existing HTML contents ===
=== Create a ZIM file from existing HTML contents ===
See [[Zimwriterfs instructions]] for an overview and read the section below on zimwriterfs for some additional context.
See [[Zimwriterfs instructions]] for an overview and read the section below on zimwriterfs for some additional context.
=== wget-2-zim ===
[https://github.com/ballerburg9005/wget-2-zim wget-2-zim] is a simple bash script with some nifty tricks that can be used to archive websites on the internet.
=== Zimit ===
[https://github.com/openzim/zimit Zimit] ([https://youzim.it online version]) is a scraper allowing to create ZIM file from any website. ''As of 2022 the ZIM files it produces are incompatible with kiwix-desktop, because the Web ARChive implementation it uses require ServiceWorkers (only kiwix-android, kiwix-serve).''


== Developers ==
== Developers ==
Line 44: Line 50:
zimwriterfs is a console tool to create ZIM files from a localy stored directory containing a "self-sufficient" HTML content (with pictures, javascript, stylesheets). The result will contain all the files of the local directory compressed and merged in the ZIM file. Nothing more, nothing less. For now, zimwriterfs only works on POSIX compatible systems. You simply need to compile it and run it. The software does not need a lot of resources, but if you create a pretty big ZIM files, then it could take a while to complete.  
zimwriterfs is a console tool to create ZIM files from a localy stored directory containing a "self-sufficient" HTML content (with pictures, javascript, stylesheets). The result will contain all the files of the local directory compressed and merged in the ZIM file. Nothing more, nothing less. For now, zimwriterfs only works on POSIX compatible systems. You simply need to compile it and run it. The software does not need a lot of resources, but if you create a pretty big ZIM files, then it could take a while to complete.  
Instructions on how to prepare and use zimwriterfs are here [[zimwriterfs_instructions]]
Instructions on how to prepare and use zimwriterfs are here [[zimwriterfs_instructions]]
[https://github.com/wikimedia/openzim/tree/master/zimwriterfs Go to zimwriterfs source code repository].
[https://github.com/openzim/zimwriterfs Go to zimwriterfs source code repository].


A virtual machine with zimwriterfs is provided [http://download.kiwix.org/dev/ZIMmaker.ova here].
A virtual machine with zimwriterfs is provided [http://download.kiwix.org/dev/ZIMmaker.ova here].
Line 85: Line 91:


== See also ==
== See also ==
* [[ZIM File Archive]]
* [[Bindings]]
* [[Bindings]]
* [[Readers]]
* [[Readers]]

Navigation menu