Docs 入口点

从您已有的 工作区 开始。

从安装到第一个有用文档的简短路径。

此页面充当网站 MVP 的文档登录页面。它应该回答“我首先做什么?”在将更深入的读者发送到存储库文档之前。

01

网站文档从这里开始

02

Repository 文档继续深入

03

以阅读为先的引导

steps

三步入门

  • 通过 Homebrew 或直接下载安装 KatanA。
  • 打开已包含 Markdown 文档的 工作区 文件夹。
  • 在进行编辑之前使用 KatanA 来阅读、预览和比较文档。

onboarding

打开你的第一个 工作区

这些捕获显示打开任何文档之前的首次运行路径。

空白状态

从空的 工作区 视图开始

当没有 工作区 打开时,KatanA 显示清晰的空白状态,而不是将用户置于模糊的登陆视图中。

菜单路径

从菜单栏打开 工作区

通过文件 -> 打开 Workspace 可从本机菜单栏访问相同的流程。

setup

值得检查的第一个设置

打开工作区后,主题、布局和更新首选项是大多数用户首先关心的设置。

主题

深色主题预设和 live preview

KatanA 已经包含多个主题预设以及 live preview 面板,因此用户无需离开应用程序即可调整外观。

布局

目录和分割方向

布局设置显示目录可见性、目录位置、分割方向和窗格顺序。

更新

内置更新首选项

更新屏幕使自动检查频率和手动更新检查从应用程序内部可见。

workflow

首先要打开什么

  • README 文件用于项目概述和设置事实。
  • 当您在编码之前需要设计意图时,可以使用 ADRs 和规格。
  • 当您需要快速了解最近的行为变化时发布注释。