KnowX Knowledge Base
Une base de connaissances consultable pour EmDash : catégories, retours sur les articles et rapport sur ce que les lecteurs recherchent.
Extension
KnowX Knowledge Base
Une base de connaissances consultable pour EmDash : catégories, retours sur les articles et rapport sur ce que les lecteurs recherchent.
Description
KnowX transforme un site EmDash en centre d’aide. Les visiteurs cherchent une réponse, parcourent les sujets et indiquent si un article les a aidés. Vous voyez quelles recherches ne donnent rien et quels articles reçoivent plus de votes Non que Oui.
Ce que vous obtenez
- Accueil de l’aide. Une zone de recherche et des cartes de sujets. Lorsque vous avez plus d’une catégorie de premier niveau, chaque carte affiche un nom, une courte description et une icône de votre choix.
- Articles. Table des matières, copie du lien sur les titres, copie sur le code, précédent et suivant, date de dernière mise à jour, badge de version facultatif.
- Recherche. La recherche propre à EmDash, limitée aux types de contenu que vous cochez. Résultats instantanés pendant la saisie, plus une page de résultats. Chaque résultat indique de quel type de contenu il s’agit.
- FAQ. Sa propre page, avec des données FAQ pour les moteurs de recherche.
- Cet article vous a-t-il aidé. Oui ou Non sur chaque article. Après un Non, vous pouvez demander un court commentaire.
- Besoin d’aide. Un bouton de contact après une recherche sans résultat et après un vote Non. Vous définissez un lien. Masqué lorsque ce réglage est vide.
- Analyses et recherches. Les articles faibles par nom, les commentaires en texte brut, les principales recherches, les recherches sans résultat.
- Carte du tableau de bord. Les recherches sans résultat de cette semaine, et l’article le moins utile.
Comment tout s’articule
KnowX est le moteur : routes, stockage et écrans d’administration. Un plugin EmDash ne peut pas ajouter de pages à votre site ; les pages publiques sont donc fournies sous forme de kit de site que vous copiez une seule fois. Voir Installation.
Les invités cherchent, lisent et votent lorsque l’hébergeur transmet à EmDash l’adresse du visiteur (Cloudflare, ou trustedProxyHeaders). Ailleurs, les invités voient un lien de connexion pour voter, et les membres votent comme d’habitude.
Installation
Avant d’installer
1. Votre site a besoin d’un exécuteur de bac à sable. Les plugins du registre s’exécutent dans un bac à sable. Tant que le site n’en a pas, Admin, Plugins affiche « No plugins configured » et il n’y a pas de Registry dans le menu.
- Node : dans votre site, exécutez
npm install @emdash-cms/sandbox-workerd workerd, puis ajoutezsandboxRunner: "@emdash-cms/sandbox-workerd/sandbox",dansemdash()au sein deastro.config.mjs. - Cloudflare : ajoutez
import from "@emdash-cms/cloudflare";etsandboxRunner: sandbox(),. Il faut l’offre Workers Paid, la liaisonworker_loadersnomméeLOADER(décommentez-la dans votre configuration Wrangler) et un bucket R2 en tant questorage: r2(...), sans quoi l’installation s’arrête avec « Storage error while installing plugin ». Exécutez ensuitenpm run deploy.
Arrêtez le serveur de développement et relancez-le. Registry apparaît désormais dans le menu d’administration.
2. Le plugin est le moteur. Les pages visiteurs viennent de son kit de site. Un plugin du registre ne peut pas ajouter de pages à votre site. Tant que vous n’avez pas copié le kit, ses adresses (par exemple /docs/) affichent la page 404 de votre site. C’est normal. La copie du kit ci-dessous tient en une commande.
3. Il vous faut Node 22.16 ou ultérieur pour l’étape npx emdash seed.
Vérifié sur EmDash 1.3.1 avec le modèle blog, sur Node et sur Cloudflare Workers (installation depuis le registre).
Installer
-
Admin, Registry, recherchez KnowX, Install, puis acceptez les autorisations.
-
Depuis le dossier racine de votre site :
kit="$(mktemp -d)" && git clone --depth 1 \ --branch v0.2.1 \ https://github.com/wbcomdesigns/emdash-knowx \ "$kit/emdash-knowx" && "$kit/emdash-knowx/scripts/add-to-site.sh" . -
Redémarrez le serveur de développement.
-
Dans Admin, Menus, ajoutez
/docs/et/docs/faq/. -
Ouvrez KnowX, Insights, puis ajoutez des articles dans Content, Help articles.
Exécutez à nouveau l’étape 2 après chaque mise à jour. Guide : https://github.com/wbcomdesigns/emdash-knowx/blob/v0.2.1/docs/website/getting-started/install.md
FAQ
Pourquoi /docs/ renvoie-t-il une 404 après l’installation ?
Le plugin ne peut pas créer de pages. Exécutez les deux lignes du kit de l’onglet Installation, puis redémarrez le serveur de développement.
Les votes ou le journal de recherche échouent après une installation depuis le registre ?
Copiez le kit de site actuel. Les anciens kits n’appelaient que /plugins/knowx/. Une installation depuis le registre utilise un identifiant généré. Le kit actuel essaie cet identifiant, puis le nom.
Les invités peuvent-ils voter et chercher ?
Chercher et lire, toujours. Voter, lorsque l’hébergeur transmet à EmDash l’adresse du visiteur (Cloudflare, ou trustedProxyHeaders) ; ailleurs, les invités voient un lien de connexion et les membres votent.
La recherche parcourt-elle les articles et les pages ? Seulement les types de contenu que vous cochez dans Settings. Help articles est activé par défaut. Un type dont la recherche est désactivée dans sa collection ne renverra aucun résultat.
Envoie-t-il des e-mails ? Non. Le bouton de contact est un lien que vous définissez : une page, une adresse http(s) ou une adresse mailto.
Fonctionne-t-il en mode sombre ? Oui. Les couleurs du kit suivent le thème de votre site.
Existe-t-il une version payante ? Non. Tout ce qui est ici est gratuit.
Puis-je mettre une zone de recherche dans un article ? Pas avec l’installation depuis le registre. Cela nécessite une installation de confiance, et cela ne fait pas partie de cette version.
Journal des modifications
0.2.1
Après une mise à jour depuis la 0.1.x, Insights affiche sa progression de migration jusqu’à ce qu’elle soit terminée.
- Correctif - Insights n’affiche plus « None yet » tant que les votes de la 0.1.x sont encore en cours de transfert.
- Correctif - Un clic sur Oui ou Non avant le chargement du script de la page est conservé et envoyé. Copiez à nouveau le kit.
0.2.0
Chaque page d’aide, vote, recherche et écran d’administration respecte désormais la limite de Cloudflare de 10 requêtes par appel de plugin.
- Nouveau - Chaque article conserve des compteurs cumulés de Oui et de Non, mis à jour avec le vote.
- Nouveau - Un écran Searches contient Top searches et Searches with no results.
- Nouveau - Les données de la 0.1.x sont transférées pas à pas à l’ouverture d’Insights.
- Amélioration - Was this helpful répond immédiatement aux clics et montre que le vote est en cours d’envoi. Copiez à nouveau le kit.
- Correctif - Sur Cloudflare, un vote n’affiche plus « Something went wrong » après avoir été enregistré.
- Correctif - Sur Cloudflare, Insights, Settings et leurs actions n’échouent plus sur un site très sollicité.
- Correctif - La carte de configuration indique où créer les types de contenu sur un site sans SQLite.
0.1.5
- Sécurité : les votes des invités et les recherches ne sont comptés que lorsque l’hébergeur transmet à EmDash l’adresse du visiteur ; ailleurs, les invités se connectent pour voter. Journal de recherche plafonné à 5000 termes.
- Nouveau : une seule commande copie le kit et crée les types de contenu. Insights affiche une carte Set up visitor pages, et Top searches propose la recherche et la pagination.
- Correctif : Insights compte chaque recherche et chaque vote ; les pages d’aide s’alignent sur le cadre du thème ; les boutons du mode sombre atteignent 4,5:1.
Versions antérieures : https://github.com/wbcomdesigns/emdash-knowx/blob/main/CHANGELOG.md
Pour copier le kit de cette version, depuis le dossier racine de votre site :
kit="$(mktemp -d)" &&
git clone --depth 1 \
--branch v0.2.1 \
https://github.com/wbcomdesigns/emdash-knowx \
"$kit/emdash-knowx" &&
"$kit/emdash-knowx/scripts/add-to-site.sh" .