Docs 入口點

從您已有的 工作區 開始。

從安裝到第一個有用文件的簡短路徑。

此頁面充當網站 MVP 的文檔登入頁面。它應該回答“我首先做什麼?”在將更深入的讀者發送到儲存庫文件之前。

01

網站文件從這裡開始

02

Repository 文件繼續深入

03

以閱讀為先的引導

steps

三步入門

  • 透過 Homebrew 或直接下載安裝 KatanA。
  • 開啟已包含 Markdown 文件的 工作區 資料夾。
  • 在進行編輯之前使用 KatanA 來閱讀、預覽和比較文件。

onboarding

打開你的第一個 工作區

這些捕獲顯示打開任何文件之前的首次運行路徑。

空白狀態

從空的 工作區 視圖開始

當沒有 工作區 開啟時,KatanA 顯示清晰的空白狀態,而不是將使用者置於模糊的登陸視圖中。

選單路徑

從功能表列開啟 工作區

透過檔案 -> 開啟 Workspace 可從本機功能表列存取相同的流程。

setup

值得檢查的第一個設置

打開工作區後,主題、佈局和更新首選項是大多數使用者首先關心的設定。

主題

深色主題預設和 live preview

KatanA 已包含多個主題預設以及 live preview 面板,因此使用者無需離開應用程式即可調整外觀。

佈局

目錄和分割方向

版面配置顯示目錄可見性、目錄位置、分割方向和窗格順序。

更新

內建更新首選項

更新畫面使自動檢查頻率和手動更新檢查從應用程式內部可見。

workflow

首先要打開什麼

  • README 文件用於專案概述和設定事實。
  • 當您在編碼之前需要設計意圖時,可以使用 ADRs 和規格。
  • 當您需要快速了解最近的行為變化時發布註釋。