This plugin allow you to index kirby pages into typesense and make fulltext search available for your website.

This plugin is free and under MIT license, I'm glad if you find it usefull. If you plan to use it for commercial use, or if I saved you some time, please consider helping me to maintain this by either making a donation of your choice or sponsoring me.

Typesense is an opensource alternative for Algolia or ElasticSearch. It is free and provide a fast typo tolerant search engine.

To use this plugin, you need to install Typesense on your server.

Download and copy this repository to /site/plugins/typesense

Or even better, to get easy updates, install it with composer: composer require maxchene/kirby3-typesense

Edit your config file: site/config/config.php to add your own plugin configuration.

Here is what it should look like:

'maxchene.typesense' => [
        'host' => 'localhost:8108', # typesense host and port
        'key' => 'secret', # typesense API key
        'num_typos' => 2, # number of allowed typo error
        'schema' => [
            'name' => 'my-collection',
            'fields' => [
                ['name' => 'content', 'type' => 'string'],
                ['name' => 'type', 'type' => 'string']
            ]
        ],
        'templates' => [
            'article' => function (Page $page) {

            },
            'default' => function (Page $page) {
                return [
                    'content' => 'text content that should be indexed for fulltext search',
                    'type' => 'default'
                ];
            }
        ]
    ]

All fields provided in the config file will be searched.

This plugins gives you access to the $site->typesenseSearch(string $query, int $limit, int $page) method wherever $site is available: templates, controllers,...

You can also create a TypesenseSearch class :

 $searchEngine = new TypesenseSearch();
 $results =  $searchEngine->search($query, $limit, $page);