Editor de documentos — Guia do usuário

Para que serve o módulo «Docs»

O módulo é um editor rich-text completo dentro do YoBench para wikis internos, anotações pessoais e documentação de projeto. Por baixo — TipTap sobre ProseMirror: menu de comandos /, conjunto extenso de blocos, diagramas Mermaid e Draw.io, fórmulas KaTeX, wiki-links entre páginas, histórico de versões e assistente de IA.

O que você obtém:

Hierarquia de páginas — documentos aninhados com árvore na barra lateral e migalhas.
Editor rich — títulos, listas de tarefas, tabelas, citações, blocos de código com realce de sintaxe (28 linguagens), callouts, toggles, sumário, find & replace, seletor de emojis.
Diagramas e fórmulas — Mermaid, Draw.io (interativo), KaTeX.
Mídia — imagens redimensionáveis, embeds YouTube/Vimeo, anexos.
Wiki-links — [[Nome da página]] com autocompletar; backlinks rastreados automaticamente.
Histórico de versões — até 50 snapshots por página com restauração.
Assistente de IA — Summarize, Continue Writing, Translate (8 idiomas), Improve Text.
Exportação/importação — Markdown, HTML, arquivos ZIP; importar .md cria uma nova página.
Armazenamento local — todas as páginas e versões no banco criptografado do YoBench.
Favoritos e lixeira paginados — listas longas de páginas favoritas ou excluídas carregam em páginas, mantendo a barra lateral responsiva.

Parâmetros da página

Ao criar ou editar:

Título — nome exibido.
Ícone — emoji do seletor.
Imagem de capa — URL (opcional).
Pai — para aninhamento.
Flags — favorita, excluída (lixeira), modelo.

Tags e categorias ainda não estão implementadas — a estruturação acontece pela hierarquia e pelos favoritos.

Recursos do editor

Formatação

Negrito, itálico, sublinhado, riscado, código inline.
Cor do texto, realce, subscrito e sobrescrito.
Alinhamento (esquerda / centro / direita).

Blocos estruturais

Títulos H1, H2, H3.
Listas com marcadores e numeradas.
Listas de tarefas com checkboxes.
Citações, blocos de código (28 linguagens, lowlight).
Tabelas com edição de células.
Divisores horizontais.
Blocos callout: Info / Warning / Success / Error.
Blocos toggle (recolhíveis).
Sumário dinâmico (TOC).

Blocos avançados

Wiki-links — [[Nome da página]] com autocompletar para páginas existentes.
Mermaid — diagramas em código.
Draw.io — editor vetorial interativo.
KaTeX — matemática inline e em bloco.
Vídeo — embeds YouTube/Vimeo.
Imagens — upload drag-and-drop com redimensionamento.
Anexos — arquivos arbitrários anexados à página.

Comandos slash

Digite / no editor — abre um menu de inserções rápidas: /heading1, /heading2, /heading3, /bulletList, /taskList, /table, /image, /codeBlock, /math, /mermaid, /drawio, /video, /quote, /toggle, /toc, /divider e mais.

Find & Replace, seletor de emojis

Busca-substituição padrão mais seletor de emojis pela barra de ferramentas.

Histórico de versões

Um snapshot (docs_page_versions) é criado automaticamente ao trocar para outra página.
Até 50 versões por página são mantidas; as mais antigas são removidas.
No UI Histórico de versões vê-se snapshots com timestamp; Restaurar torna a versão escolhida atual e o conteúdo anterior é salvo como nova versão.

Assistente de IA

A barra do editor tem um botão de auto-melhoria. Ações disponíveis:

Summarize — resumo curto do texto selecionado ou da página.
Continue Writing — continua o texto no mesmo estilo.
Translate — traduz para 8 idiomas (inglês, russo, alemão, espanhol, francês, português, chinês, japonês).
Improve Text — melhora gramática e clareza.

Os resultados podem ser inseridos no cursor ou substituir a seleção. O provedor de IA vem das configurações globais do módulo.

Exportação e importação

Markdown (.md) — exporta a página atual.
HTML (.html) — exporta com estilos inline.
ZIP (Markdown) — todas as páginas como conjunto de .md.
ZIP (HTML) — todas as páginas como conjunto de .html.
Importar .md — cria uma nova página a partir de um arquivo.
Enviar para contexto — o conteúdo da página pode ser empurrado para o Context Manager & RAG para busca IA posterior.

Configurações globais

Em Configurações → Docs:

Provedor de IA para Docs (docsAiProviderId) — qual provedor do registro AI Chat alimenta Summarize / Continue / Translate / Improve.

Fluxo de uso

1. Crie sua primeira página

Abra o módulo Docs no menu lateral esquerdo.
Na barra lateral clique em + Nova página.
Insira um título e opcionalmente escolha um ícone.
Abra a página.

2. Escreva conteúdo

Digite o texto; / abre o menu slash.
Arraste arquivos direto para o editor para anexos e imagens.
Use [[]] para wiki-link para outra página.

3. Monte a estrutura

Arraste páginas na barra lateral para mudar hierarquia.
Marque páginas frequentes como Favoritas.

4. Use o assistente de IA

Selecione texto → botão IA na barra → escolha uma ação. O resultado é inserido ou substitui a seleção.

5. Volte para uma versão

Abra o painel Histórico de versões → escolha um snapshot → Restaurar. O conteúdo atual é preservado como mais uma versão.

6. Exporte

Menu da página → Exportar → escolha um formato. Para toda a árvore — Exportar ZIP.

Próximos passos

Conecte os provedores de IA para o assistente de IA funcionar.
Empurre sua documentação para Contextos e RAG para que o AI Chat responda a partir dela.
Para mapas mentais e quadro branco, use o Board.

Ajuda e feedback

Quer tags, edição colaborativa ou mais formatos de exportação? Escreva para nós pelo formulário de contato.