From 614f15913fd36341c728ad69c6ffaef3bc0ac497 Mon Sep 17 00:00:00 2001 From: Veloman Yunkan Date: Fri, 9 Dec 2022 17:05:18 +0400 Subject: [PATCH] Added introduction to kiwix-serve's documentation --- docs/kiwix-serve.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/kiwix-serve.rst b/docs/kiwix-serve.rst index 1227619..842bce5 100644 --- a/docs/kiwix-serve.rst +++ b/docs/kiwix-serve.rst @@ -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 =====