E EmDash CMS Everything Guides, use cases, plugins, templates
Português

KnowX Knowledge Base

Uma base de conhecimento pesquisável para o EmDash: categorias, opiniões sobre os artigos e um relatório do que os leitores pesquisam.

Extensão

KnowX Knowledge Base

Uma base de conhecimento pesquisável para o EmDash: categorias, opiniões sobre os artigos e um relatório do que os leitores pesquisam.

  • Categoria: knowledge base
  • Estado: Disponível
  • Versão: 0.2.1
  • Preço: Desconhecido
  • Origem: Registro oficial de plugins
  • Instalação: Plugin sandbox do registro
  • Verificado: 2026-10-21
Abrir no Claude Abrir no ChatGPT
Partilhar no X Partilhar no LinkedIn Partilhar no Reddit

Descrição

O KnowX transforma um site EmDash num centro de ajuda. Os visitantes procuram uma resposta, exploram os temas e indicam se um artigo ajudou. Você vê que pesquisas não encontram nada e que artigos recebem mais votos de Não do que de Sim.

O que obtém

  • Página inicial da ajuda. Uma caixa de pesquisa e cartões de temas. Quando tem mais de uma categoria de nível superior, cada cartão mostra um nome, uma breve descrição e um ícone à sua escolha.
  • Artigos. Índice, copiar ligação nos títulos, copiar no código, anterior e seguinte, data da última atualização, distintivo de versão opcional.
  • Pesquisa. A pesquisa própria do EmDash, limitada aos tipos de conteúdo que assinalar. Resultados instantâneos enquanto escreve, mais uma página de resultados. Cada resultado indica de que tipo de conteúdo se trata.
  • FAQ. A sua própria página, com dados de FAQ para os motores de pesquisa.
  • Isto foi útil. Sim ou Não em cada artigo. Depois de um Não pode pedir um breve comentário.
  • Ainda precisa de ajuda. Um botão de contacto após uma pesquisa vazia e após um voto de Não. Define uma ligação. Oculto quando esta definição está vazia.
  • Análises e pesquisas. Os artigos fracos por nome, os comentários como texto simples, as principais pesquisas, as pesquisas que não encontraram nada.
  • Cartão do painel. As pesquisas vazias desta semana e o artigo menos útil.

Como tudo se encaixa

O KnowX é o motor: rotas, armazenamento e os ecrãs de administração. Um plugin do EmDash não pode acrescentar páginas ao seu site, pelo que as páginas públicas seguem como um kit de site que copia uma só vez. Veja Instalação.

Os convidados pesquisam, leem e votam quando o anfitrião dá ao EmDash o endereço do visitante (Cloudflare, ou trustedProxyHeaders). Noutros casos, os convidados veem uma ligação de início de sessão para votar, e os membros votam como de costume.

Instalação

Antes de instalar

1. O seu site precisa de um executor de sandbox. Os plugins do registo correm numa sandbox. Enquanto o site não tiver um, Admin, Plugins mostra «No plugins configured» e não há Registry no menu.

  • Node: no seu site, execute npm install @emdash-cms/sandbox-workerd workerd e depois acrescente sandboxRunner: "@emdash-cms/sandbox-workerd/sandbox", dentro de emdash() em astro.config.mjs.
  • Cloudflare: acrescente import from "@emdash-cms/cloudflare"; e sandboxRunner: sandbox(),. Precisa do plano Workers Paid, da ligação worker_loaders chamada LOADER (descomente-a na sua configuração do Wrangler) e de um bucket R2 como storage: r2(...), ou a instalação pára com «Storage error while installing plugin». Depois execute npm run deploy.

Pare o servidor de desenvolvimento e volte a iniciá-lo. Registry aparece agora no menu de administração.

2. O plugin é o motor. As páginas dos visitantes vêm do seu kit de site. Um plugin do registo não pode acrescentar páginas ao seu site. Até copiar o kit, os seus endereços (por exemplo /docs/) mostram a página 404 do seu site. É o esperado. A cópia do kit abaixo demora um único comando.

3. Precisa do Node 22.16 ou posterior para o passo npx emdash seed.

Verificado no EmDash 1.3.1 com o modelo blog, em Node e no Cloudflare Workers (instalação a partir do registo).

Instalar

  1. Admin, Registry, pesquise KnowX, Install e aceite as permissões.

  2. A partir da pasta raiz do seu 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" .

  3. Reinicie o servidor de desenvolvimento.

  4. Em Admin, Menus, adicione /docs/ e /docs/faq/.

  5. Abra KnowX, Insights e depois adicione artigos em Content, Help articles.

Volte a executar o passo 2 após cada atualização. Guia: https://github.com/wbcomdesigns/emdash-knowx/blob/v0.2.1/docs/website/getting-started/install.md

Perguntas frequentes

Porque é que /docs/ dá um 404 após a instalação? O plugin não pode criar páginas. Execute as duas linhas do kit do separador Installation e depois reinicie o servidor de desenvolvimento.

Os votos ou o registo de pesquisas falham após uma instalação a partir do registo? Copie o kit de site atual. Os kits antigos só chamavam /plugins/knowx/. Uma instalação a partir do registo usa um id gerado. O kit atual tenta esse id e depois o nome.

Os convidados podem votar e pesquisar? Pesquisar e ler, sempre. Votar, quando o anfitrião dá ao EmDash o endereço do visitante (Cloudflare, ou trustedProxyHeaders); noutros casos os convidados veem uma ligação de início de sessão e os membros votam.

A pesquisa percorre artigos e páginas? Apenas os tipos de conteúdo que assinalar em Settings. Help articles está ativado por predefinição. Um tipo com a pesquisa desativada na sua coleção não devolverá resultados.

Envia e-mail? Não. O botão de contacto é uma ligação que define: uma página, um endereço http(s) ou um endereço mailto.

Funciona no modo escuro? Sim. As cores do kit seguem o tema do seu site.

Existe uma versão paga? Não. Tudo o que está aqui é gratuito.

Posso pôr uma caixa de pesquisa dentro de um artigo? Não com a instalação a partir do registo. Isso exige uma instalação de confiança e não faz parte desta versão.

Registo de alterações

0.2.1

Depois de atualizar a partir da 0.1.x, o Insights mostra o progresso da migração até terminar.

  • Correção - O Insights já não mostra «None yet» enquanto os votos da 0.1.x ainda estão a ser transferidos.
  • Correção - Um clique em Sim ou Não antes de o script da página carregar é mantido e enviado. Volte a copiar o kit.

0.2.0

Cada página de ajuda, voto, pesquisa e ecrã de administração cabe agora no limite do Cloudflare de 10 pedidos por chamada de plugin.

  • Novo - Cada artigo guarda contagens acumuladas de Sim e Não, atualizadas com o voto.
  • Novo - Um ecrã Searches contém Top searches e Searches with no results.
  • Novo - Os dados da 0.1.x são transferidos passo a passo ao abrir o Insights.
  • Melhoria - Was this helpful responde aos cliques de imediato e mostra que o voto está a ser enviado. Volte a copiar o kit.
  • Correção - No Cloudflare, um voto já não mostra «Something went wrong» depois de ter sido guardado.
  • Correção - No Cloudflare, o Insights, o Settings e as suas ações já não falham num site com muito tráfego.
  • Correção - O cartão de configuração indica onde criar os tipos de conteúdo num site sem SQLite.

0.1.5

  • Segurança: os votos de convidados e as pesquisas só são contados quando o anfitrião dá ao EmDash o endereço do visitante; noutros casos os convidados iniciam sessão para votar. Registo de pesquisas limitado a 5000 termos.
  • Novo: um só comando copia o kit e cria os tipos de conteúdo. O Insights mostra um cartão Set up visitor pages, e o Top searches tem pesquisa e paginação.
  • Correção: o Insights conta cada pesquisa e voto; as páginas de ajuda alinham-se com a moldura do tema; os botões do modo escuro atingem 4,5:1.

Versões anteriores: https://github.com/wbcomdesigns/emdash-knowx/blob/main/CHANGELOG.md

Para copiar o kit desta versão, a partir da pasta raiz do seu 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" .