Intégration de Plausible Analytics
Ajoutez Plausible Analytics à votre site de documentation. Une alternative légère et respectueuse de la vie privée à Google Analytics.
Ajoutez Plausible Analytics à votre site de documentation pour obtenir des données de trafic sans cookies ni scripts de suivi qui pistent les utilisateurs sur le web.
Plausible est open source, pèse moins de 1 Ko, et ne nécessite pas de bannière de consentement aux cookies dans la plupart des juridictions. C'est une bonne option si vous voulez une analytique simple, conforme au RGPD.
Si vous avez besoin d'une gestion du consentement (ou si vous utilisez aussi GA, GTM ou Crisp), consultez Cookie Consent.
Il existe deux façons d'ajouter Plausible. Choisissez celle qui correspond à votre configuration :
| Configuration | À utiliser quand | Champ |
|---|---|---|
| Standard | Vous êtes sur le plan gratuit de Plausible, ou payant sans besoin de proxy | domain |
| Script proxy | Vous êtes sur un plan payant et voulez contourner les bloqueurs de publicité | scriptUrl |
Configuration standard (domain)
C'est l'option par défaut pour la plupart des utilisateurs. Enregistrez votre site sur Plausible et indiquez le domaine.
Inscrivez-vous sur Plausible
Créez un compte sur Plausible Analytics et ajoutez le domaine de votre site de documentation (par exemple, docs.example.com).
Ajoutez le domaine à docs.json
{
"name": "My Docs",
"integrations": {
"plausible": {
"domain": "docs.example.com"
}
}
}Utilisez exactement le domaine que vous avez enregistré : docs.example.com, et non www.docs.example.com.
Serveur auto-hébergé
Si vous exécutez la Community Edition, ajoutez le champ server afin que le script et l'API d'événements pointent vers votre instance :
{
"name": "My Docs",
"integrations": {
"plausible": {
"domain": "docs.example.com",
"server": "https://analytics.example.com"
}
}
}server ne fonctionne qu'avec domain. Les scripts proxy gèrent leur propre routage.
Configuration du script proxy (scriptUrl)
Les plans payants de Plausible offrent des scripts proxy avec un nom de fichier unique (comme pa-XXXXX.js). Ceux-ci contournent la plupart des bloqueurs de publicité car l'URL du script ne correspond pas aux listes de filtres courantes.
Récupérez l'URL de votre script proxy
Dans les paramètres de votre site Plausible, trouvez la section du script proxy et copiez l'URL complète. Elle ressemble à https://plausible.io/js/pa-XXXXX.js.
Ajoutez l'URL du script à docs.json
{
"name": "My Docs",
"integrations": {
"plausible": {
"scriptUrl": "https://plausible.io/js/pa-XXXXX.js"
}
}
}Aucun champ domain ou server n'est nécessaire. L'identité de votre site est intégrée dans l'ID du script, et le CDN de Plausible gère le routage en interne.
Vérifier l'installation
Après avoir ajouté l'intégration :
- Déclenchez un rebuild de votre documentation
- Visitez votre site de documentation en ligne
- Consultez votre dashboard Plausible. Votre visite devrait apparaître en quelques secondes.
- Ou ouvrez DevTools, allez dans l'onglet Network, et recherchez une requête vers
plausible.io/js/script.js(standard) ou votre scriptpa-XXXXX.js(proxy)
Plausible affiche les données en temps réel, sans période d'attente comme Google Analytics.
Référence de configuration
| Champ | Type | Requis | Description |
|---|---|---|---|
domain | string | L'un de domain ou scriptUrl | Le domaine de votre site tel qu'enregistré dans Plausible. Utilisé comme attribut data-domain sur la balise script. |
scriptUrl | string | L'un de domain ou scriptUrl | URL complète vers un script proxy payant de Plausible (pa-XXXXX.js). L'identité du site est intégrée dans le script, donc aucun champ domain n'est nécessaire. |
server | string | Non | URL d'un serveur Plausible auto-hébergé. Utilisé uniquement avec domain, pas avec scriptUrl. |
Dépannage
Neuf fois sur dix, c'est le domaine. Il doit correspondre exactement à ce que vous avez enregistré dans Plausible (donc docs.example.com, et non www.docs.example.com).
Si le domaine semble correct :
- Reconstruisez votre documentation. Les changements de configuration ne prennent effet qu'après un nouveau build.
- Vérifiez la présence de bloqueurs de publicité. Certaines extensions de navigateur bloquent les scripts d'analytique, y compris Plausible. Si c'est la cause, passez à la configuration du script proxy.
- Inspectez le code source de la page pour une balise
<script>avecdata-domain(standard) ou votre nom de fichierpa-XXXXX.js(proxy). Si elle n'est pas présente, la configuration ne s'est pas appliquée.
Enregistrez le domaine que vos utilisateurs visitent réellement. Si votre documentation se trouve sur docs.example.com, utilisez-le comme domain, et non votre domaine racine.
Passez à la configuration du script proxy. Le nom de fichier unique contourne la plupart des listes de filtres des bloqueurs de publicité. L'auto-hébergement obtient le même résultat, puisque le script se charge depuis votre propre domaine.
Utilisez domain si vous êtes sur le plan gratuit ou si les bloqueurs de publicité ne vous préoccupent pas. Utilisez scriptUrl si vous êtes sur un plan payant et voulez une couverture de suivi maximale. Ne définissez pas les deux ; choisissez-en un.