快速上手

立即透過現有的工作區開始工作。

從安裝到開啟第一個文件的簡短流程指南。

本指南致力於解決「我該先做什麼」的疑惑。進階需求請查閱GitHub深度文檔。

01

網站入門指引

02

關聯官方文檔

03

以閱覽為核心的引導

快速指引

打開資料夾,像審閱者一樣閱讀

KatanA在處理已有文檔庫時最具價值。它不強制要求任何新的內容組織模式。

前五分鐘

前五分鐘檢查清單

  • 在真實工作區開啟 README。
  • 開啟一個架構規格檔。
  • 開啟一個圖表較多的 markdown 檔。
  • 確認 TOC 與 split preview 行為。
  • 檢查一次更新設定。

SDD與AI

SDD / AI 工作流補充

在請 AI 修改規格前,先用 KatanA 閱讀並核對規格內容。

三步開始體驗

  • 透過Homebrew或GitHub下載包完成安裝。
  • 將包含Markdown文件的資料夾作為工作區開啟。
  • 在編輯之前,優先使用KatanA檢視、預覽或對比文件。

開啟您的第一個工作區

首次啟動且尚未開啟文件時的產品引導路徑。

初始狀態

簡潔的導航起始頁

未載入文件時,KatanA提供明確的操作入口,而非讓您迷失在空白視圖中。

功能表

透過功能表列啟動工作區

您也可以隨時透過頂層原生選單:文件 -> 開啟工作區 來操作。

推薦配置項

在開啟專案後,這些外觀及功能的個性化調整值得一試。

主題

深色預設及即時預覽

內建多種配色方案,支援在設定面版直接觀測其在編輯器上的效果。

佈局

目錄及預覽方向

自由配置側邊目錄的顯隱、位置以及分割預覽的排列方向。

Update

更新偏好設定

在此配置自動檢查新版本的頻率,或進行手動檢測。

Shortcuts

鍵盤快捷鍵設定

依照您的工作流程自由自訂鍵盤快捷鍵。

優先關注哪些內容

  • README檔案:快速獲取專案概況及核心配置說明。
  • ADR或規範文件:在進入編碼前理清設計初衷。
  • Release Notes:掌握最新的特性變更與修復說明。

Support

支持 KatanA 開發

若這條安裝指令有幫助,歡迎為 KatanA 點 Star 或贊助。

How to star on GitHub