Docs punto di ingresso

Inizia con area di lavoro che già possiedi.

Un breve percorso dall'installazione al primo documento utile.

Questa pagina funge da pagina di destinazione dei documenti per il sito Web MVP. Dovrebbe rispondere "cosa devo fare prima?" prima di inviare lettori più approfonditi ai documenti del repository.

01

I documenti del sito web iniziano qui

02

I documenti Repository continuano più in profondità

03

Onboarding incentrato sullo spettatore

steps

Iniziare in tre passaggi

  • Installa KatanA tramite Homebrew o un download diretto.
  • Apri una cartella area di lavoro che contiene già la documentazione Markdown.
  • Utilizza KatanA per leggere, visualizzare in anteprima e confrontare i documenti prima di apportare modifiche.

onboarding

Apertura del tuo primo area di lavoro

Queste acquisizioni mostrano il percorso di prima esecuzione prima che i documenti vengano aperti.

Stato vuoto

Inizia dalla vista area di lavoro vuota

Quando nessun area di lavoro è aperto, KatanA mostra uno stato chiaro e vuoto invece di trascinare gli utenti in una visualizzazione di destinazione ambigua.

Percorso del menù

Apri un area di lavoro dalla barra dei menu

Lo stesso flusso è raggiungibile dalla barra dei menu nativa tramite File -> Apri Workspace.

setup

Prime impostazioni che vale la pena controllare

Dopo aver aperto un area di lavoro, il tema, il layout e le preferenze di aggiornamento sono le prime impostazioni che interesseranno alla maggior parte degli utenti.

Tema

Preimpostazioni del tema scuro e live preview

KatanA include già più temi predefiniti oltre a un pannello live preview, in modo che gli utenti possano ottimizzare l'aspetto senza uscire dall'app.

Disposizione

Sommario e direzione di suddivisione

Le impostazioni del layout espongono la visibilità del sommario, la posizione del sommario, la direzione di suddivisione e l'ordine dei riquadri.

Aggiornamenti

Preferenze di aggiornamento integrate

La schermata di aggiornamento rende visibili la frequenza dei controlli automatici e i controlli degli aggiornamenti manuali dall'interno dell'app.

workflow

Cosa aprire prima

  • File README per la panoramica del progetto e le informazioni di configurazione.
  • ADRs e specifiche quando è necessario l'intento progettuale prima della codifica.
  • Note sulla versione quando è necessario comprendere rapidamente i recenti cambiamenti di comportamento.