Docs punto de entrada

Comience con el espacio de trabajo que ya tiene.

Un breve camino desde la instalación hasta el primer documento útil.

Esta página actúa como página de inicio de documentos para el sitio web MVP. Debería responder "¿qué hago primero?" antes de enviar lectores más profundos a los documentos del repositorio.

01

Los documentos del sitio web comienzan aquí

02

Los documentos Repository continúan más profundamente

03

Incorporación del espectador primero

steps

Empezando en tres pasos

  • Instale KatanA hasta Homebrew o una descarga directa.
  • Abra una carpeta espacio de trabajo que ya contenga documentación Markdown.
  • Utilice KatanA para leer, obtener una vista previa y comparar documentos antes de realizar modificaciones.

onboarding

Abriendo tu primer espacio de trabajo

Estas capturas muestran la ruta de primera ejecución antes de que se abra cualquier documento.

Estado en blanco

Comience desde la vista espacio de trabajo vacía

Cuando no hay ningún espacio de trabajo abierto, KatanA muestra un estado en blanco claro en lugar de dejar a los usuarios en una vista de aterrizaje ambigua.

Ruta del menú

Abra un espacio de trabajo desde la barra de menú

Se puede acceder al mismo flujo desde la barra de menú nativa a través de Archivo -> Abrir Workspace.

setup

Primeras configuraciones que vale la pena comprobar

Después de abrir un espacio de trabajo, el tema, el diseño y las preferencias de actualización son las primeras configuraciones que interesarán a la mayoría de los usuarios.

Tema

Ajustes preestablecidos de tema oscuro y live preview

KatanA ya incluye múltiples ajustes preestablecidos de temas además de un panel live preview, para que los usuarios puedan ajustar la apariencia sin salir de la aplicación.

Disposición

Tabla de contenidos y dirección dividida.

La configuración de diseño expone la visibilidad de la tabla de contenidos, la posición de la TOC, la dirección de división y el orden de los paneles.

Actualizaciones

Preferencias de actualización integradas

La pantalla de actualización hace visibles la frecuencia de verificación automática y las verificaciones de actualización manual desde el interior de la aplicación.

workflow

Que abrir primero

  • Archivos README para descripción general del proyecto y datos de configuración.
  • ADRs y especificaciones cuando necesita la intención del diseño antes de codificar.
  • Notas de publicación cuando necesite comprender rápidamente los cambios de comportamiento recientes.