Leia. Verifique. Compartilhe.

Transforme o tempo entre documentos em tempo para pensar.

De README e diagramas a documentos PDF e Office, o KatanA abre, permite ler, editar e compartilhar os documentos do projeto em um único workspace para desktop.

macOS Windows Linux GitHub
Árvore de arquivos, fonte Markdown e prévia exibidas juntas no KatanAÁrvore de arquivos, fonte Markdown e prévia exibidas juntas no KatanA
Alterne entre arquivos e visualizações sem perder o contexto do projeto.

01

Comece diretamente pelos seus documentos.

Você não precisa movê-los para outro local. Abra o projeto local e escolha como lê-lo conforme o objetivo.

Transforme o repositório em um espaço de trabalho legível.

Percorra README, especificações e materiais complementares pela árvore de arquivos e pelas abas. A busca do workspace cobre Markdown e permite filtrar por maiúsculas, palavras inteiras e expressões regulares.

  1. Abra como workspace a pasta que contém os documentos.
  2. Escolha um documento na árvore de arquivos e abra os materiais relacionados em outra aba.
  3. Use a busca no documento ou a busca Markdown do workspace para chegar ao trecho que deseja verificar.

Você pode comparar documentos relacionados no mesmo workspace usando a estrutura de pastas como referência.

Árvore de arquivos do KatanA e prévia do README selecionadoÁrvore de arquivos do KatanA e prévia do README selecionado

Verifique a fonte e a visualização juntas.

Exiba a fonte Markdown e a prévia lado a lado para conferir mudanças no texto e na sintaxe. Ajuste a orientação, a ordem dos painéis e o índice conforme o trabalho.

  1. Abra um arquivo .md ou .markdown e ative a visualização dividida entre fonte e prévia.
  2. Edite o texto ou os títulos e confira o resultado na prévia.
  3. Confira o conteúdo e salve-o. Se necessário, exporte para HTML, PDF, PNG ou JPEG.

Você pode conferir o resultado na tela antes de salvá-lo explicitamente. Não presuma o salvamento automático: salve o documento.

Fonte Markdown e resultado renderizado lado a lado no KatanAFonte Markdown e resultado renderizado lado a lado no KatanA

Mantenha os diagramas no mesmo contexto do texto.

Renderize Mermaid, PlantUML e Draw.io dentro do Markdown. Confira a relação com a explicação antes de reabrir o diagrama em outra ferramenta.

  1. Indique as linguagens mermaid, plantuml ou drawio nos blocos de código Markdown.
  2. Prepare PlantUML com @startuml / @enduml e Draw.io como XML não compactado.
  3. Confira o diagrama e o texto ao redor na prévia e exporte o documento se necessário.

Você pode revisar a definição do diagrama junto com a explicação. Consulte o guia de formatos para conhecer a sintaxe e as condições de entrada.

Vários diagramas exibidos dentro do Markdown no KatanAVários diagramas exibidos dentro do Markdown no KatanA

02

Formatos diferentes, um só workspace.

Nem todos os formatos podem ser editados da mesma forma. Apresentamos separadamente os recursos e as condições de entrada de cada formato.

HTML

Abre documentos HTML, permite exibi-los e editar sua fonte. Usa um caminho de prévia HTML separado do Markdown para conferir e editar materiais web existentes.

As alterações são aplicadas ao arquivo por meio de uma operação de salvamento.

Mermaid / PlantUML

Renderiza diagramas a partir de blocos de código Markdown com mermaid e plantuml, delimitando a entrada PlantUML com as diretivas de início e fim.

PlantUML exige @startuml / @enduml.

Draw.io

Renderiza diagramas colocando XML não compactado em um bloco de código drawio. Confira o formato de entrada antes de usá-lo.

É necessário XML não compactado que inclua <mxfile> ou <mxGraphModel>.

03

Três passos até abrir o primeiro documento.

Comece pelo README do projeto que você usa normalmente. Teste a forma de leitura com arquivos que já possui.

  1. Obtenha o pacote para seu sistema operacional.

    Baixe diretamente o arquivo da versão publicada pelos botões de macOS, Windows ou Linux. Consulte a página de instalação para ver o procedimento.

  2. Abra a pasta que contém os documentos.

    Abra a pasta do projeto como workspace. Se necessário, configure a profundidade de exploração, os diretórios excluídos e as extensões visíveis.

  3. Leia, verifique e compartilhe.

    Selecione os documentos na árvore e avance com abas, busca e visualização dividida. Para exportar Markdown, escolha o formato conforme o destino do compartilhamento.

04

O que saber antes de começar.

Deixamos claros tanto os recursos disponíveis quanto os limites para lidar com arquivos.

Office e PDF são para leitura.

Os documentos binários aceitos são PDF, DOCX, XLSX e PPTX. Eles abrem somente em prévia, portanto não equivalem aos recursos de edição dos aplicativos Office.

Documentos binários têm limites de entrada.

O tamanho máximo é 256 MiB. MIME e assinatura do arquivo são verificados além da extensão; arquivos cujo formato declarado não coincide com o conteúdo real não podem ser abertos.

Confira e salve as alterações.

Salvar Markdown é uma ação explícita. A atualização da prévia e o salvamento no disco são separados: salve o documento antes de terminar.

Confira o resultado com materiais reais.

Verifique layouts complexos e a sintaxe dos diagramas com os arquivos que usará. Você pode relatar problemas no aplicativo incluindo as condições de reprodução.

Respondemos primeiro às dúvidas comuns.

É um aplicativo apenas para Markdown?

Não. Além de Markdown, ele aceita HTML, PDF, Word (DOCX), Excel (XLSX) e PowerPoint (PPTX). O alcance de edição e leitura varia conforme o formato.

Em quais sistemas operacionais ele funciona?

Há distribuições publicadas para macOS, Windows e Linux. Antes de instalar, confira o pacote e o ambiente de destino.

Qual é a diferença para as bibliotecas da série KatanA?

KatanA é um aplicativo desktop pronto para usar. As bibliotecas da série são componentes para desenvolvedores integrarem modelos de documentos, renderização ou UI em seus próprios aplicativos.

KatanA / Desktop

Faça sua próxima revisão com KatanA.

Teste com seus documentos habituais a leitura usando árvore, abas e prévia.