diff --git a/docs/index.rst b/docs/index.rst index 3f40e6337..a190afa97 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,3 +12,4 @@ Welcome to libkiwix's documentation! usage api/ref_api + widget diff --git a/docs/widget.rst b/docs/widget.rst new file mode 100644 index 000000000..40104b37c --- /dev/null +++ b/docs/widget.rst @@ -0,0 +1,82 @@ +Kiwix serve widget +==================== + +Introduction +------------ + +The kiwix-serve widget provides an easy to embed way to show the `kiwix-serve` homepage. + +Usage +----- + +To use the widget, simply add an iframe with its `src` attribute set to the `widget` endpoint. +Example HTML Page :: + + + + + Widget Test + + + + + + +This creates an iframe with the kiwix-serve homepage contents. + +Arguments are explained below. + +Possible Arguments +------------------- + +Currently, the following arguments are supported. + +disabledesc (value = N/A) + Disables the description part of a tile. + +disablefilter (value = N/A) + Disables the search filters: language, category, tag and search function. + +disableclick (value = N/A) + Disables clicking the book to open it for reading. + +disabledownload (value = N/A) + Disables the download button (if avaialable at all) on the tile. + + +Custom CSS and JS +----------------- + +You can add your custom CSS rules and Javascript code to the widget. + +To do that, use the following code as template:: + + + + + + +The CSS/JS fields are optional, you may send both or only one. +