Offline Documentation Discussion

New approach.

Offline reader Kiwix (requires ZIM file):


ZIM file creation from mediawiki:


Help welcome!

I heard news that httrack is not developed since 2017. Github has an html version of the wiki already. In what way can that be improved?

Zim files are single files, but it should be noted that the Firefox reader add-on can only search titles for terms, not content.

1 Like

I made a functional .zim file using Zimwriterfs[1] and WhonixBOT’s html wiki from Github. Zimwriter requires a png favicon, so I upscaled the Whonix website favicon. HTML wiki is 144MB as a zip, 254 MB uncompressed. The Zim file is 65 MB. I can upload the file if requested.

edit: problem with in-page TOC links (firefox doesn’t know where to find it) but links across different pages works.
[1] https://download.openzim.org/release/zimwriterfs/


How does zimmer fare? Is it easy to set up?

To anyone… How is whonix-wiki-html? Useful? Any limitations?

As far as I understand https://openzim.org/wiki/Build_your_ZIM_file one can go

website -> HTML dump -> ZIM file

Or directly

website -> ZIM file

Why not go for the ZIM file? Why take the extra step through HTML?

We need a script or at least instructions on how to create the ZIM file.

Would MWoffliner produce better results?

Zimwriterfs is simple to use, the interface for the viewer is simple too. It uses a start page and has a search function, but only for page titles. Good for kiosk applications.

There are different options for viewers/servers, but I use the extension for Firefox. Some features are crippled (e.g. service workers) so viewing active content is not possible with this browser. Some files error when following links between articles, not sure if that is the extension or the html of the source at fault.

I love it! Browsing complete html is so much better than markdown. Limitation: I remember one or two “link not found” hyperlinks that should have been. That’s a common issue for mirrored websites, though.

No load on Whonix servers and I am comfortable with using the HTML dumps.

Sadly, I don’t know how to script.

$ /.zimwriterfs

Usage: zimwriterfs [mandatory arguments] [optional arguments] HTML_DIRECTORY ZIM_FILE

$ ./zimwriterfs --welcome=Documentation.html --favicon=favicon.png --language=eng -title=‘The Whonix Wiki’ --description=‘A crash course in anonymity and security on the Internet’ --creator=‘Whonix Project’ --publisher=daniel.d whonix-wiki Whonix_Wiki.zim

1 Like
[Imprint] [Privacy Policy] [Cookie Policy] [Terms of Use] [E-Sign Consent] [DMCA] [Investors] [Priority Support] [Professional Support]