Skip to content
Create a ZIM of StackExchange websites
JavaScript Python HTML CSS Shell Dockerfile
Branch: master
Clone or download

README.md

Sotoki

Stack Overflow to Kiwix

The goal of this project is to create a suite of tools to create zim files required by kiwix reader to make available Stack Overflow offline (without access to Internet).

PyPI Docker Build Status CodeFactor License: GPL v3

Getting started

The use of btrfs as a file system is recommended (and required for stackoverflow)

Install non python dependencies:

sudo apt-get install jpegoptim pngquant gifsicle advancecomp python-pip python-virtualenv python-dev libxml2-dev libxslt1-dev libbz2-dev p7zip-full python-pillow gif2apng imagemagick

Create a virtual environment for python:

virtualenv --system-site-packages venv

Activate the virtual enviroment:

source venv/bin/activate

Install this lib:

pip install sotoki

Usage:

sotoki <domain> <publisher> [--directory=<dir>] [--nozim] [--tag-depth=<tag_depth>] [--threads=<threads>] [--zimpath=<zimpath>] [--reset] [--reset-images] [--clean-previous] [--nofulltextindex] [--ignoreoldsite] [--nopic] [--no-userprofile]

You can use sotoki -h to have more explanation about these options

Example

for S in `./list_all.sh` ; do sotoki $S Kiwix --threads=12 --reset --clean-previous --no-userprofile ; done

License

GPLv3 or later, see LICENSE for more details.

You can’t perform that action at this time.