Docs ponto de entrada

Comece com o espaço de trabalho que você já possui.

Um breve caminho desde a instalação até o primeiro documento útil.

Esta página funciona como página inicial de documentos para o site MVP. Deve responder 'o que eu faço primeiro?' antes de enviar leitores mais profundos aos documentos do repositório.

01

Os documentos do site começam aqui

02

Os documentos Repository continuam mais aprofundados

03

Integração que prioriza o visualizador

steps

Começando em três etapas

  • Instale KatanA por meio de Homebrew ou por download direto.
  • Abra uma pasta espaço de trabalho que já contém documentação Markdown.
  • Use KatanA para ler, visualizar e comparar documentos antes de fazer edições.

onboarding

Abrindo seu primeiro espaço de trabalho

Essas capturas mostram o caminho da primeira execução antes de qualquer documento ser aberto.

Estado em branco

Comece na visualização espaço de trabalho vazia

Quando nenhum espaço de trabalho está aberto, KatanA mostra um estado em branco em vez de colocar os usuários em uma visualização de destino ambígua.

Caminho do menu

Abra um espaço de trabalho na barra de menu

O mesmo fluxo pode ser acessado na barra de menu nativa através de Arquivo -> Abrir Workspace.

setup

Primeiras configurações que vale a pena verificar

Depois de abrir um espaço de trabalho, as preferências de tema, layout e atualização são as primeiras configurações com as quais a maioria dos usuários se importará.

Tema

Predefinições de tema escuro e live preview

KatanA já inclui várias predefinições de tema, além de um painel live preview, para que os usuários possam ajustar a aparência sem sair do aplicativo.

Disposição

Índice e direção dividida

As configurações de layout expõem a visibilidade do índice, a posição do sumário, a direção de divisão e a ordem dos painéis.

Atualizações

Preferências de atualização integradas

A tela de atualização torna a frequência de verificação automática e as verificações manuais de atualização visíveis de dentro do aplicativo.

workflow

O que abrir primeiro

  • README arquivos para visão geral do projeto e fatos de configuração.
  • ADRs e especificações quando você precisar da intenção do design antes da codificação.
  • Libere notas quando precisar entender rapidamente as mudanças recentes de comportamento.