KnowX Knowledge Base
Eine durchsuchbare Wissensdatenbank für EmDash: Kategorien, Artikel-Feedback und ein Bericht darüber, wonach Leser suchen.
Erweiterung
KnowX Knowledge Base
Eine durchsuchbare Wissensdatenbank für EmDash: Kategorien, Artikel-Feedback und ein Bericht darüber, wonach Leser suchen.
Beschreibung
KnowX macht aus einer EmDash-Website ein Hilfecenter. Besucher suchen nach einer Antwort, stöbern in Themen und geben an, ob ein Artikel geholfen hat. Sie sehen, welche Suchen nichts finden und welche Artikel mehr Nein- als Ja-Stimmen bekommen.
Was Sie bekommen
- Hilfe-Startseite. Ein Suchfeld und Themenkarten. Haben Sie mehr als eine Kategorie der obersten Ebene, zeigt jede Karte einen Namen, eine kurze Beschreibung und ein von Ihnen gewähltes Symbol.
- Artikel. Inhaltsverzeichnis, Link kopieren an Überschriften, Kopieren bei Code, Vorheriger und Nächster, Datum der letzten Aktualisierung, optionales Versionsabzeichen.
- Suche. Die eigene Suche von EmDash, beschränkt auf die Inhaltstypen, die Sie anhaken. Sofortige Ergebnisse während der Eingabe, dazu eine Ergebnisseite. Jedes Ergebnis nennt die Art des Inhalts.
- FAQ. Eine eigene Seite, mit FAQ-Daten für Suchmaschinen.
- War das hilfreich. Ja oder Nein bei jedem Artikel. Nach einem Nein können Sie um einen kurzen Kommentar bitten.
- Noch Hilfe nötig. Eine Kontaktschaltfläche nach einer leeren Suche und nach einer Nein-Stimme. Sie legen einen Link fest. Ausgeblendet, wenn diese Einstellung leer ist.
- Einblicke und Suchen. Schwache Artikel nach Namen, Kommentare als einfacher Text, Top-Suchen, Suchen ohne Treffer.
- Dashboard-Karte. Leere Suchen dieser Woche und der am wenigsten hilfreiche Artikel.
Wie alles zusammenpasst
KnowX ist der Motor: Routen, Speicher und die Admin-Bildschirme. Ein EmDash-Plugin kann Ihrer Website keine Seiten hinzufügen, daher werden die öffentlichen Seiten als Website-Kit geliefert, das Sie einmal hineinkopieren. Siehe Installation.
Gäste suchen, lesen und stimmen ab, wenn der Host EmDash die Adresse des Besuchers liefert (Cloudflare oder trustedProxyHeaders). Anderswo sehen Gäste zum Abstimmen einen Anmelde-Link, und Mitglieder stimmen wie gewohnt ab.
Installation
Vor der Installation
1. Ihre Website braucht einen Sandbox-Runner. Registry-Plugins laufen in einer Sandbox. Solange die Website keinen hat, zeigt Admin, Plugins „No plugins configured“ an, und im Menü gibt es kein Registry.
- Node: Führen Sie in Ihrer Website
npm install @emdash-cms/sandbox-workerd workerdaus und fügen Sie dannsandboxRunner: "@emdash-cms/sandbox-workerd/sandbox",innerhalb vonemdash()inastro.config.mjshinzu. - Cloudflare: Fügen Sie
import from "@emdash-cms/cloudflare";undsandboxRunner: sandbox(),hinzu. Es braucht den Tarif Workers Paid, dieworker_loaders-Bindung namensLOADER(in Ihrer Wrangler-Konfiguration auskommentieren) und einen R2-Bucket alsstorage: r2(...), sonst bricht die Installation mit „Storage error while installing plugin“ ab. Führen Sie dannnpm run deployaus.
Beenden Sie den Entwicklungsserver und starten Sie ihn neu. Registry erscheint jetzt im Admin-Menü.
2. Das Plugin ist der Motor. Die Besucherseiten stammen aus seinem Website-Kit. Ein Registry-Plugin kann Ihrer Website keine Seiten hinzufügen. Bis Sie das Kit kopieren, zeigen seine Adressen (zum Beispiel /docs/) die 404-Seite Ihrer Website. Das ist zu erwarten. Das Kopieren des Kits unten braucht einen Befehl.
3. Sie benötigen Node 22.16 oder neuer für den Schritt npx emdash seed.
Geprüft mit EmDash 1.3.1 und der Vorlage blog, auf Node und auf Cloudflare Workers (Registry-Installation).
Installieren
-
Admin, Registry, suchen Sie KnowX, Install, und akzeptieren Sie dann die Berechtigungen.
-
Aus dem Stammordner Ihrer Website:
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" . -
Starten Sie den Entwicklungsserver neu.
-
Fügen Sie unter Admin, Menus
/docs/und/docs/faq/hinzu. -
Öffnen Sie KnowX, Insights, und fügen Sie dann Artikel unter Content, Help articles hinzu.
Führen Sie nach jedem Update Schritt 2 erneut aus. Anleitung: https://github.com/wbcomdesigns/emdash-knowx/blob/v0.2.1/docs/website/getting-started/install.md
FAQ
Warum ist /docs/ nach der Installation eine 404?
Das Plugin kann keine Seiten erstellen. Führen Sie die zwei Kit-Zeilen aus dem Tab Installation aus und starten Sie dann den Entwicklungsserver neu.
Abstimmungen oder Suchprotokoll schlagen nach einer Registry-Installation fehl?
Kopieren Sie das aktuelle Website-Kit. Ältere Kits riefen nur /plugins/knowx/ auf. Eine Registry-Installation verwendet eine generierte ID. Das aktuelle Kit probiert diese ID, dann den Namen.
Können Gäste abstimmen und suchen?
Suchen und Lesen immer. Abstimmen, wenn der Host EmDash die Adresse des Besuchers liefert (Cloudflare oder trustedProxyHeaders); anderswo sehen Gäste einen Anmelde-Link, und Mitglieder stimmen ab.
Durchsucht die Suche Beiträge und Seiten? Nur die Inhaltstypen, die Sie unter Settings anhaken. Help articles ist standardmäßig aktiviert. Ein Typ, dessen Suche in seiner Collection deaktiviert ist, liefert keine Ergebnisse.
Sendet es E-Mails? Nein. Die Kontaktschaltfläche ist ein Link, den Sie festlegen: eine Seite, eine http(s)-Adresse oder eine mailto-Adresse.
Funktioniert es im Dunkelmodus? Ja. Die Farben des Kits folgen dem Theme Ihrer Website.
Gibt es eine kostenpflichtige Version? Nein. Alles hier ist kostenlos.
Kann ich ein Suchfeld in einen Artikel einfügen? Nicht mit der Registry-Installation. Das erfordert eine vertrauenswürdige Installation und ist nicht Teil dieser Version.
Änderungsprotokoll
0.2.1
Nach dem Update von 0.1.x zeigt Insights seinen Upgrade-Fortschritt an, bis er abgeschlossen ist.
- Fehlerbehebung - Insights zeigt nicht mehr „None yet“, solange Stimmen aus 0.1.x noch übernommen werden.
- Fehlerbehebung - Ein Klick auf Ja oder Nein, bevor das Seitenskript geladen ist, wird behalten und gesendet. Kopieren Sie das Kit erneut.
0.2.0
Jede Hilfeseite, Abstimmung, Suche und jeder Admin-Bildschirm hält jetzt das Cloudflare-Limit von 10 Anfragen pro Plugin-Aufruf ein.
- Neu - Jeder Artikel führt laufende Ja- und Nein-Zähler, die mit der Abstimmung aktualisiert werden.
- Neu - Ein Bildschirm Searches enthält Top searches und Searches with no results.
- Neu - Daten aus 0.1.x werden beim Öffnen von Insights Schritt für Schritt übernommen.
- Verbesserung - Was this helpful beantwortet Klicks sofort und zeigt, dass die Stimme gesendet wird. Kopieren Sie das Kit erneut.
- Fehlerbehebung - Auf Cloudflare zeigt eine Stimme nach dem Speichern nicht mehr „Something went wrong“.
- Fehlerbehebung - Auf Cloudflare schlagen Insights, Settings und deren Aktionen auf einer stark ausgelasteten Website nicht mehr fehl.
- Fehlerbehebung - Die Einrichtungskarte nennt, wo auf einer Website ohne SQLite die Inhaltstypen anzulegen sind.
0.1.5
- Sicherheit: Gaststimmen und Suchen werden nur gezählt, wenn der Host EmDash die Adresse des Besuchers liefert; anderswo melden sich Gäste zum Abstimmen an. Suchprotokoll auf 5000 Begriffe begrenzt.
- Neu: Ein Befehl kopiert das Kit und legt die Inhaltstypen an. Insights zeigt eine Karte Set up visitor pages, und Top searches hat Suche und Seitenwechsel.
- Fehlerbehebung: Insights zählt jede Suche und Stimme; Hilfeseiten richten sich am Theme-Rahmen aus; Schaltflächen im Dunkelmodus erreichen 4,5:1.
Ältere Versionen: https://github.com/wbcomdesigns/emdash-knowx/blob/main/CHANGELOG.md
Um das Kit für diese Version zu kopieren, aus dem Stammordner Ihrer Website:
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" .