..  include:: /Includes.rst.txt

..  _start:

====================
TYPO3 Search Algolia
====================

:Extension key:
    typo3_search_algolia

:Package name:
    meine-krankenkasse/typo3-search-algolia

:Version:
    |release|

:Language:
    en

:Author:
    mkk – meine krankenkasse

:License:
    This document is published under the
    `CC BY-SA 4.0 <https://creativecommons.org/licenses/by-sa/4.0/>`__
    license. The extension itself is licensed under GPL-3.0-or-later.

:Rendered:
    |today|

----

A TYPO3 extension that integrates `Algolia <https://www.algolia.com/>`__
search into your website by indexing TYPO3 pages, content elements, news
and files.

..  card-grid::
    :columns: 1
    :columns-md: 2
    :gap: 4
    :class: pb-4
    :card-height: 100

    ..  card:: Introduction

        What the extension does and what it needs.

        ..  card-footer:: :ref:`Read more <introduction>`
            :button-style: btn btn-secondary stretched-link

    ..  card:: Installation

        Installing the extension via Composer and setting up the database.

        ..  card-footer:: :ref:`Read more <installation>`
            :button-style: btn btn-secondary stretched-link

    ..  card:: Configuration

        Algolia credentials, search engine and indexing service records.

        ..  card-footer:: :ref:`Read more <configuration>`
            :button-style: btn btn-secondary stretched-link

    ..  card:: Indexers

        The built-in indexers and the fields they send to Algolia.

        ..  card-footer:: :ref:`Read more <indexers>`
            :button-style: btn btn-secondary stretched-link

..  toctree::
    :maxdepth: 2
    :titlesonly:
    :hidden:

    Introduction/Index
    Installation/Index
    Configuration/Index
    Indexers/Index