vrr/kiwix-tools
2
0
Fork 0
mirror of https://github.com/kiwix/kiwix-tools.git synced 2026-04-28 03:30:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added introduction to kiwix-serve's documentation

Browse source
This commit is contained in:
Veloman Yunkan 2022-12-09 17:05:18 +04:00
parent 6957a8cb1e
commit 614f15913f
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/kiwix-serve.rst
View file

@ -2,6 +2,22 @@
kiwix-serve
***********
Introduction
============
``kiwix-serve`` is a tool for serving ZIM file content over HTTP. It supports
serving a library containing multiple ZIM files. In a large library served by a
``kiwix-serve`` instance clients can look up/filter ZIM files of interest by
words in their titles and/or descriptions, language, tags, etc.
``kiwix-serve`` provides a ZIM file viewer for displaying inidividual pages
from a ZIM file inside the user's web browser (without downloading the full ZIM
file).
Clients can also remotely search inside those ZIM files that contain a full-text
search database.
Usage
=====