README.md

ZIM Reader documentation

zim download simple-wiki
zim index simple-wiki
zim search "offline encyclopedia" simple-wiki
zim serve simple-wiki

Start here

• Installation: install the CLI and its semantic-search runtime dependency.
• Quick start: download, inspect, index, search, read, and serve an archive.
• Configuration: configure the library, server, search, and SQLite index.

Command reference

• Command overview
• Download
• Library, info, list, and remove
• Index and search
• Read and extract
• Serve

Run zim help for the authoritative command summary. Examples use either a configured library name such as simple-wiki or an explicit portable path such as ./archives/example.zim.

Workflows

• Basic workflow
• Library management
• Searching
• Web server

Architecture

• Overview
• Design decisions
• Search system
• HTTP server
• ZIM format

Return to the project README for build and contribution information.