Delaware.Kentico.Xperience.Typesense
1.0.13-beta-1
See the version list below for details.
dotnet add package Delaware.Kentico.Xperience.Typesense --version 1.0.13-beta-1
NuGet\Install-Package Delaware.Kentico.Xperience.Typesense -Version 1.0.13-beta-1
<PackageReference Include="Delaware.Kentico.Xperience.Typesense" Version="1.0.13-beta-1" />
paket add Delaware.Kentico.Xperience.Typesense --version 1.0.13-beta-1
#r "nuget: Delaware.Kentico.Xperience.Typesense, 1.0.13-beta-1"
// Install Delaware.Kentico.Xperience.Typesense as a Cake Addin #addin nuget:?package=Delaware.Kentico.Xperience.Typesense&version=1.0.13-beta-1&prerelease // Install Delaware.Kentico.Xperience.Typesense as a Cake Tool #tool nuget:?package=Delaware.Kentico.Xperience.Typesense&version=1.0.13-beta-1&prerelease
Xperience by Kentico Typesense integration by delaware consulting
Description
This integration enables you to create Typesense search collections to collection content of pages (content types with the 'Page' feature enabled) from the Xperience content tree using a code-first approach. To provide a search interface for the collectioned content, developers can use the .NET API, JavaScript API, or the InstantSearch.js library.
Be aware that this integration has been developed by delaware consulting and is not an official Kentico product.
Library Version Matrix
Xperience Version | Library Version |
---|---|
>= 29.0.0 | >= 4.1.0 |
28.x | >= 3.x |
>= 26.2.0, < 27.0.0 | 2.x |
Dependencies
Package Installation
Add the package to your application using the .NET CLI
dotnet add package Kentico.Xperience.Typesense
Quick Start
Add configuration from your Typesense account to the ASP.NET Core
appsettings.json
file:"CMSTypesenseSearch": { "ApiKey": "<your collectioning API key>", "Node": { "Host": "<your typesense host (localhost)>", "Port": <your typesense port (8108)>, "Protocol": "<your typesense protocol (http)>" } },
Define a custom
DefaultTypesenseCollectionStrategy
implementation to customize how content pages/content items are processed for the collection. SeeCustom-collection-strategy.md
Add this library to the application services, registering your custom
DefaultTypesenseCollectionStrategy
and Typesense services// Program.cs services.AddKenticoTypesense(configuration); services.RegisterStrategy<GlobalTypesenseCollectionStrategy>("DefaultStrategy");
Create an collection in Xperience's Administration within the Search application added by this library.
Rebuild the collection in Xperience's Administration within the Search application added by this library.
Display the results on your site with a Razor View 👍 .
Full Instructions
View the Usage Guide for more detailed instructions.
Contributing
To see the guidelines for Contributing to Kentico open source software, please see Kentico's CONTRIBUTING.md
for more information and follow the Kentico's CODE_OF_CONDUCT
.
Instructions and technical details for contributing to this project can be found in Contributing Setup.
License
Distributed under the MIT License. See LICENSE.md
for more information.
Support
We didn't provide support for this project, but you can submit an issue or a pull request. The feedbacks are welcome.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net8.0
- Kentico.Xperience.WebApp (>= 29.0.0)
- Typesense (>= 7.11.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Delaware.Kentico.Xperience.Typesense:
Package | Downloads |
---|---|
Delaware.Kentico.Xperience.Typesense.Admin
Admin part.Enables the creation of Typesense search indexes and the indexing of Xperience website channel pages and reusable content items. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.16-beta-1 | 43 | 8/28/2024 |
1.0.15-beta-1 | 53 | 8/28/2024 |
1.0.14-beta-1 | 34 | 8/28/2024 |
1.0.13-beta-1 | 28 | 8/28/2024 |
1.0.12-beta-1 | 32 | 8/28/2024 |
1.0.11-beta-1 | 59 | 8/13/2024 |
1.0.10-beta-1 | 38 | 8/13/2024 |
1.0.9-beta-1 | 39 | 8/13/2024 |
1.0.8-beta-1 | 53 | 8/13/2024 |
1.0.7-beta-1 | 41 | 8/13/2024 |
1.0.6-beta-1 | 43 | 8/1/2024 |
1.0.4-beta-1 | 41 | 8/1/2024 |
1.0.3-beta-1 | 52 | 7/16/2024 |
1.0.2-beta-1 | 49 | 7/5/2024 |
1.0.1-beta-1 | 50 | 7/2/2024 |
1.0.0-beta-1 | 51 | 7/2/2024 |
0.0.5-beta-1 | 47 | 7/2/2024 |