> For the complete documentation index, see [llms.txt](https://docs.morpht.com/convivial-personalisation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.morpht.com/convivial-personalisation/readme.md).

# Introduction

*Library version 0.0.1*

Clientside personalisation engine for building profiles and ranking content.

Convivial Personalisation uses data from many sources, including metatags, URL parameters, cookies, saved values in local storage, page content and HTTP resources. Builders choose which inputs to collect, how to process them and where to publish the results through JSON configuration.

The library and this guide are maintained in the `convivial-personalisation` repository. The examples use its browser bundle and the `ConvivialPersonalisation` API.

## What it does

* Collect and transform values through configurable sources and processors.
* Count interests in dimensions such as topics or audiences, record page views and searches, and store values with expiry.
* Publish values to local storage or cookies, fill form fields and emit data-layer events through destinations.
* Optionally learn named profiles, use them to rank candidate content supplied by the site, and explain each ranked block with the terms that selected it.

Profiles are optional. The builder chooses their names, number and settings when the site needs learned content matching. Collection, dimensions and destinations also work independently. Persistence, cookie publication and analytics follow the configured consent controls.

## Use the guide

* [Getting started](/convivial-personalisation/getting-started.md): load the library, configure a pipeline and use its output.
* [Concepts and tools](/convivial-personalisation/concepts-and-tools.md): profiler operations, engine state, ranking and consent.
* [Configuration](/convivial-personalisation/configuration.md): define sources, processors, destinations and optional learning settings.
* [Usage](/convivial-personalisation/usage.md): publish audience choices, rank content and integrate with Drupal.
* [Reference](/convivial-personalisation/reference.md): JavaScript methods, options and built-in plugins.
* [Support](/convivial-personalisation/support.md): diagnose unexpected results and get help from Morpht.

## Conventions

* Code names and settings are written as `rank()`, `profile.fields` and `temp.topics`.
* Commands run from the repository root unless stated otherwise.
* Durations are in seconds unless another unit is given. Example values are identified separately from library defaults.