KnowX Knowledge Base
EmDash 用の検索できるナレッジベース:カテゴリ、記事へのフィードバック、読者が検索した内容のレポート。
プラグイン
KnowX Knowledge Base
EmDash 用の検索できるナレッジベース:カテゴリ、記事へのフィードバック、読者が検索した内容のレポート。
説明
KnowX は EmDash サイトをヘルプセンターに変えます。訪問者は答えを検索し、トピックを閲覧し、記事が役に立ったかどうかを伝えられます。何も見つからなかった検索や、「はい」より「いいえ」の票が多い記事を確認できます。
主な機能
- ヘルプのホーム。 検索ボックスとトピックカード。トップレベルのカテゴリが複数ある場合、各カードに名前、短い説明、選んだアイコンが表示されます。
- 記事。 目次、見出しのリンクコピー、コードのコピー、前後の記事、最終更新日、オプションのバージョンバッジ。
- 検索。 EmDash 自身の検索で、チェックを入れたコンテンツタイプに限定されます。入力中に即座に結果が表示され、結果ページもあります。各結果にはコンテンツの種類が示されます。
- FAQ。 専用のページがあり、検索エンジン向けの FAQ データも含まれます。
- この記事は役に立ちましたか。 各記事に「はい」か「いいえ」。「いいえ」の後に、短いコメントを求められます。
- まだ解決しませんか。 検索結果が空だった後と「いいえ」の投票の後に、問い合わせボタンを表示します。リンクを 1 つ設定します。その設定が空のときは非表示になります。
- インサイトと検索。 効果の低い記事を名前で、コメントをプレーンテキストで、人気の検索、何も見つからなかった検索を表示します。
- ダッシュボードカード。 今週の結果が空だった検索と、最も役に立たなかった記事。
全体の仕組み
KnowX はエンジンです。ルート、ストレージ、管理画面を担います。EmDash プラグインはサイトにページを追加できないため、公開ページは一度コピーするサイトキットとして提供されます。「インストール」を参照してください。
ホストが訪問者のアドレスを EmDash に渡す場合(Cloudflare、または trustedProxyHeaders)、ゲストは検索、閲覧、投票ができます。それ以外の環境では、ゲストが投票するにはサインインのリンクが表示され、会員は通常どおり投票します。
インストール
インストールの前に
1. サイトにはサンドボックスランナーが必要です。 レジストリのプラグインはサンドボックスで実行されます。サイトにサンドボックスランナーがない間は、Admin、Plugins に「No plugins configured」と表示され、メニューに Registry もありません。
- Node: サイトで
npm install @emdash-cms/sandbox-workerd workerdを実行し、astro.config.mjsのemdash()の中にsandboxRunner: "@emdash-cms/sandbox-workerd/sandbox",を追加します。 - Cloudflare:
import from "@emdash-cms/cloudflare";とsandboxRunner: sandbox(),を追加します。Workers Paid プラン、LOADERという名前のworker_loadersバインディング(Wrangler の設定でコメントを外します)、そしてstorage: r2(...)としての R2 バケットが必要です。そうでないと、インストールは「Storage error while installing plugin」で止まります。その後、npm run deployを実行します。
開発サーバーを停止して再度起動します。管理メニューに Registry が表示されるようになります。
2. プラグインはエンジンです。訪問者向けのページは、そのサイトキットから提供されます。 レジストリのプラグインはサイトにページを追加できません。キットをコピーするまでは、そのアドレス(たとえば /docs/)にはサイトの 404 ページが表示されます。これは想定どおりです。下のキットのコピーは 1 つのコマンドで済みます。
3. Node 22.16 以降が必要です。 npx emdash seed のステップのために必要です。
blog テンプレートを使い、EmDash 1.3.1 の Node と Cloudflare Workers(レジストリからのインストール)で確認しています。
インストール手順
-
Admin、Registry で KnowX を検索し、Install して、権限を承認します。
-
サイトのルートフォルダーで次を実行します。
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" . -
開発サーバーを再起動します。
-
Admin、Menus で
/docs/と/docs/faq/を追加します。 -
KnowX、Insights を開き、Content、Help articles で記事を追加します。
更新のたびに手順 2 をもう一度実行してください。ガイド:https://github.com/wbcomdesigns/emdash-knowx/blob/v0.2.1/docs/website/getting-started/install.md
よくある質問
インストール後に /docs/ が 404 になるのはなぜですか?
プラグインはページを作成できません。Installation タブにある 2 行のキットのコマンドを実行し、その後に開発サーバーを再起動してください。
レジストリからのインストール後に、投票や検索ログが失敗します。
最新のサイトキットをコピーしてください。古いキットは /plugins/knowx/ しか呼び出しませんでした。レジストリからのインストールでは、生成された ID が使われます。最新のキットは、その ID を試し、次に名前を試します。
ゲストは投票や検索ができますか?
検索と閲覧は常にできます。投票は、ホストが訪問者のアドレスを EmDash に渡す場合(Cloudflare、または trustedProxyHeaders)にできます。それ以外ではゲストにサインインのリンクが表示され、会員が投票します。
検索は投稿やページも対象にしますか? Settings でチェックを入れたコンテンツタイプだけです。Help articles は既定でオンです。コレクションで検索がオフになっているタイプは結果を返しません。
メールを送信しますか? いいえ。問い合わせボタンは、あなたが設定するリンクです。ページ、http(s) のアドレス、または mailto のアドレスを指定できます。
ダークモードで動作しますか? はい。キットの色はサイトのテーマに従います。
有料版はありますか? いいえ。ここにあるものはすべて無料です。
記事の中に検索ボックスを置けますか? レジストリからのインストールではできません。信頼されたインストールが必要で、このリリースには含まれていません。
変更履歴
0.2.1
0.1.x から更新した後、Insights は完了するまでアップグレードの進行状況を表示します。
- 修正 - 0.1.x の投票がまだ移行中の間、Insights が「None yet」と表示しなくなりました。
- 修正 - ページのスクリプトが読み込まれる前の「はい」または「いいえ」のクリックが保持され、送信されます。キットをもう一度コピーしてください。
0.2.0
すべてのヘルプページ、投票、検索、管理画面が、Cloudflare のプラグイン呼び出し 1 回あたり 10 リクエストという上限に収まるようになりました。
- 新機能 - 各記事が「はい」と「いいえ」の累計を保持し、投票に合わせて更新されます。
- 新機能 - 新しい Searches 画面に、人気の検索と結果なしの検索があります。
- 新機能 - 0.1.x のデータは、Insights を開くたびに少しずつ移行されます。
- 改善 - 「この記事は役に立ちましたか」はクリックにすぐ応答し、投票を送信中であることを表示します。キットをもう一度コピーしてください。
- 修正 - Cloudflare で、保存された後に投票が「Something went wrong」と表示されなくなりました。
- 修正 - Cloudflare で、Insights、Settings、およびそれらの操作が、混雑したサイトでも失敗しなくなりました。
- 修正 - SQLite のないサイトで、コンテンツタイプをどこで作成するかをセットアップカードが示します。
0.1.5
- セキュリティ:ゲストの投票と検索は、ホストが訪問者のアドレスを EmDash に渡す場合にのみカウントされます。それ以外の環境では、ゲストは投票するためにサインインします。検索ログは 5000 語に制限されます。
- 新機能:1 つのコマンドでキットをコピーし、コンテンツタイプを作成します。Insights に Set up visitor pages カードが表示され、Top searches に検索とページ送りが付きました。
- 修正:Insights がすべての検索と投票をカウントします。ヘルプページがテーマのフレームに揃います。ダークモードのボタンのコントラストが 4.5:1 を満たします。
以前のバージョン:https://github.com/wbcomdesigns/emdash-knowx/blob/main/CHANGELOG.md
このバージョンのキットをコピーするには、サイトのルートフォルダーで次を実行します。
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" .