PHPackages                             maxchene/kirby3-typesense - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Search & Filtering](/categories/search)
4. /
5. maxchene/kirby3-typesense

ActiveKirby-plugin[Search & Filtering](/categories/search)

maxchene/kirby3-typesense
=========================

Kirby plugin that use typesense for quick search

1.0.2(2y ago)2293MITPHPPHP >=8.1

Since Mar 13Pushed 2y ago3 watchersCompare

[ Source](https://github.com/maxchene/kirby3-typesense)[ Packagist](https://packagist.org/packages/maxchene/kirby3-typesense)[ Docs](https://github.com/maxchene/kirby3-typesense)[ RSS](/packages/maxchene-kirby3-typesense/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (3)Versions (3)Used By (0)

Kirby Typesense
===============

[](#kirby-typesense)

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

Overview
--------

[](#overview)

> 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](https://www.paypal.com/paypalme/maximechene)of your choice or [sponsoring me](https://github.com/sponsors/maxchene).

1. Install Typesense on your server
-----------------------------------

[](#1-install-typesense-on-your-server)

### 1.1 What is Typesense ?

[](#11-what-is-typesense-)

[Typesense](https://typesense.org) is an opensource alternative for Algolia or ElasticSearch. It is free and provide a fast typo tolerant search engine.

### 1.2 Install Typesense

[](#12-install-typesense)

To use this plugin, you need to [install Typesense on your server](https://typesense.org/docs/guide/install-typesense.html).

2. Install the Kirby Typesense plugin
-------------------------------------

[](#2-install-the-kirby-typesense-plugin)

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`

3. Configuration
----------------

[](#3-configuration)

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'
                ];
            }
        ]
    ]
```

### 3.1 Schema configuration

[](#31-schema-configuration)

### 3.2 Templates configuration

[](#32-templates-configuration)

4. Use fulltext search
----------------------

[](#4-use-fulltext-search)

All fields provided in the config file will be searched.

ParamDescriptionTypeOptionnalDefault value$queryyour search stringstringno$limitMaximum number of results per pageintegeryes30$pagePage numberintegeryes1
### 4.1 Site method

[](#41-site-method)

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

### 4.2 Typesense Search

[](#42-typesense-search)

You can also create a TypesenseSearch instance :

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

5. Command Line
---------------

[](#5-command-line)

6. Full configuration exemple
-----------------------------

[](#6-full-configuration-exemple)

7. TODOS
--------

[](#7-todos)

- add command line tools
- improve docs or enable wiki pages for this repo
- maybe add a Page method to build indexed content

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~142 days

Total

2

Last Release

1010d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/9c1a15529bbcb1a1412a5c88d8fdf6175cc747cde24f17b2809caf92d502557b?d=identicon)[maxchene](/maintainers/maxchene)

---

Top Contributors

[![maxchene](https://avatars.githubusercontent.com/u/3726973?v=4)](https://github.com/maxchene "maxchene (34 commits)")

---

Tags

fulltext-searchkirbykirby-cmskirby-plugintypesensesearchfulltextkirbytypesensekirby3kirby3-pluginkirby3-cms

### Embed Badge

![Health badge](/badges/maxchene-kirby3-typesense/health.svg)

```
[![Health](https://phpackages.com/badges/maxchene-kirby3-typesense/health.svg)](https://phpackages.com/packages/maxchene-kirby3-typesense)
```

###  Alternatives

[teamtnt/tntsearch

A fully featured full text search engine written in PHP

3.2k3.0M28](/packages/teamtnt-tntsearch)[typesense/laravel-scout-typesense-driver

Laravel Scout Driver for Typesense

144637.2k3](/packages/typesense-laravel-scout-typesense-driver)[bvdputte/kirby-bettersearch

A search plugin for Kirby (v3+ that searches for full word combinations rather than just individual words.

233.5k](/packages/bvdputte-kirby-bettersearch)[fabianmichael/kirby-meta

Your all-in-one powerhouse for any SEO and metadata needs imaginable.

6910.7k1](/packages/fabianmichael-kirby-meta)[cmsig/seal

Search Engine Abstraction Layer

32207.9k53](/packages/cmsig-seal)[cmsig/seal-symfony-bundle

An integration of CMS-IG SEAL search abstraction into Symfony Framework.

15195.8k5](/packages/cmsig-seal-symfony-bundle)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)