快速上手

立即通过现有的工作区开始工作。

从安装到打开第一个文档的简短流程指南。

本指南致力于解决“我也该先做什么”的疑惑。进阶需求请查阅GitHub深度文档。

01

网站入门指引

02

关联官方文档

03

以阅览为核心的引导

快速指引

打开文件夹,像审阅者一样阅读

KatanA在处理已有文档库时最具价值。它不强制要求任何新的内容组织模式。

前五分钟

前五分钟检查清单

  • 在真实工作区打开 README。
  • 打开一个架构规格文件。
  • 打开一个图表较多的 markdown 文件。
  • 确认 TOC 与 split preview 行为。
  • 检查一次更新设置。

SDD与AI

SDD / AI 工作流说明

在让 AI 修改规格前,先用 KatanA 阅读并核对规格。

三步开始体验

  • 通过Homebrew或GitHub下载包完成安装。
  • 将包含Markdown文档的文件夹作为工作区打开。
  • 在编辑之前,优先使用KatanA检视、预览或对比文档。

开启您的第一个工作区

首次启动且尚未打开文档时的产品引导路径。

初始状态

简洁的导航起始页

未加载文档时,KatanA提供明确的操作入口,而非让您迷失在空白视图中。

菜单系统

通过菜单栏激活工作区

您也可以随时通过顶层原生菜单:文件 -> 打开工作区 来操作。

推荐配置项

在开启项目后,这些外观及功能的个性化调整值得一试。

主题

深色预设及实时预览

内置多种配色方案,支持在设置面板直接观测其在编辑器上的效果。

布局

目录及预览方向

自由配置侧边目录的显隐、位置以及分栏预览的排列方向。

更新

自动化维护选项

在此配置自动检查新版本的频率,或进行手动检测。

Shortcuts

键盘快捷键设置

根据您的工作流自由定制键盘快捷键。

优先关注哪些内容

  • README文件:快速获取项目概况及核心配置说明。
  • ADR或规范文档:在进入编码前理清设计初衷。
  • Release Notes:掌握最新的特性变更和修复说明。

Support

支持 KatanA 开发

如果这条安装命令对你有帮助,欢迎为 KatanA 点 Star 或赞助。

How to star on GitHub