KnowX Knowledge Base
EmDash용 검색 가능한 지식 베이스: 카테고리, 문서 피드백, 독자가 검색하는 내용에 대한 보고서.
플러그인
KnowX Knowledge Base
EmDash용 검색 가능한 지식 베이스: 카테고리, 문서 피드백, 독자가 검색하는 내용에 대한 보고서.
설명
KnowX는 EmDash 사이트를 도움말 센터로 바꿔 줍니다. 방문자는 답을 검색하고, 주제를 둘러보고, 문서가 도움이 되었는지 알려 줄 수 있습니다. 어떤 검색이 결과를 찾지 못하는지, 어떤 문서가 “예”보다 “아니요”를 더 많이 받는지 확인할 수 있습니다.
제공되는 기능
- 도움말 홈. 검색 상자와 주제 카드. 최상위 카테고리가 둘 이상이면 각 카드에 이름, 짧은 설명, 사용자가 고른 아이콘이 표시됩니다.
- 문서. 목차, 제목의 링크 복사, 코드 복사, 이전 및 다음, 마지막 업데이트 날짜, 선택 사항인 버전 배지.
- 검색. EmDash 자체의 검색이며, 체크한 콘텐츠 유형으로 제한됩니다. 입력하는 즉시 결과가 표시되고 결과 페이지도 있습니다. 각 결과에는 어떤 종류의 콘텐츠인지 표시됩니다.
- FAQ. 별도의 페이지가 있으며 검색 엔진을 위한 FAQ 데이터가 포함됩니다.
- 도움이 되었나요. 각 문서에 “예” 또는 “아니요”. “아니요” 후에는 짧은 의견을 요청할 수 있습니다.
- 아직 도움이 필요하신가요. 검색 결과가 없을 때와 “아니요” 투표 후에 문의 버튼이 표시됩니다. 링크 하나를 설정합니다. 이 설정이 비어 있으면 숨겨집니다.
- 인사이트와 검색. 효과가 낮은 문서를 이름으로, 의견을 일반 텍스트로, 인기 검색, 결과를 찾지 못한 검색을 보여 줍니다.
- 대시보드 카드. 이번 주 결과 없는 검색과 가장 도움이 되지 않은 문서.
전체 구조
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 페이지가 표시됩니다. 이는 정상입니다. 아래의 키트 복사는 명령 하나면 됩니다.
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 탭의 두 줄짜리 키트 명령을 실행한 다음 개발 서버를 다시 시작하세요.
레지스트리 설치 후 투표나 검색 로그가 실패합니다.
최신 사이트 키트를 복사하세요. 이전 키트는 /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의 플러그인 호출당 요청 10개 제한 안에 들어갑니다.
- 신규 - 각 문서가 “예”와 “아니요”의 누적 수를 유지하며 투표와 함께 업데이트됩니다.
- 신규 - 새 Searches 화면에 인기 검색과 결과 없는 검색이 있습니다.
- 신규 - 0.1.x의 데이터는 Insights를 열 때마다 한 단계씩 옮겨집니다.
- 개선 - “도움이 되었나요”가 클릭에 즉시 응답하고 투표가 전송 중임을 표시합니다. 키트를 다시 복사하세요.
- 수정 - Cloudflare에서 투표가 저장된 후 더는 “Something went wrong”이 표시되지 않습니다.
- 수정 - Cloudflare에서 Insights, Settings와 그 동작이 바쁜 사이트에서도 더는 실패하지 않습니다.
- 수정 - SQLite가 없는 사이트에서 콘텐츠 유형을 어디에서 만들어야 하는지 설정 카드가 알려 줍니다.
0.1.5
- 보안: 호스트가 방문자의 주소를 EmDash에 전달할 때만 손님의 투표와 검색이 집계되며, 그 외에는 손님이 투표하려면 로그인합니다. 검색 로그는 5000개 용어로 제한됩니다.
- 신규: 명령 하나로 키트를 복사하고 콘텐츠 유형을 만듭니다. 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" .