返回功能特色
核心功能
符號嵌入
透過名稱而非行號將即時程式碼嵌入文件。編輯原始碼，文件自動更新。
example.md
# 透過名稱嵌入函式
![[auth.py#validate_token]]Ohai 從 auth.py 提取 validate_token 函式，並以語法高亮的方式內嵌渲染。當函式變更時，您的文件自動更新。
為何重要
傳統文件會逐漸腐朽。您將程式碼複製貼上到 Markdown，程式碼持續演化，突然間文件就在對您說謊。符號嵌入將原始碼檔案視為唯一真實來源，從根本解決了這個問題。
不同於每次重構就會失效的行號參照，符號嵌入使用 AST 解析透過實際名稱尋找程式碼——函式、類別、結構、常數。重新命名檔案、重組程式碼、新增方法——只要符號名稱存在，您的文件就能保持準確。
使用場景
API 文件
參照實際的函式簽章，而非會逐漸偏離同步的手動輸入近似值。
架構決策記錄
在 ADR 中嵌入您正在討論的程式碼。隨著程式碼庫演化，範例始終保持最新。
新人引導文件
透過可信賴且與儲存庫相符的即時程式碼，向新進開發者展示身份驗證的運作方式。
程式碼審查
將特定函式提取到 Markdown 摘要中，進行非同步審查和討論。
教學文件
逐步引導真實實作。讀者可以信賴程式碼範例始終保持最新。
維運手冊
嵌入維運團隊在事件發生時需要參照的確切設定或腳本。
支援的程式語言
透過 Tree-sitter AST 解析支援 30 種以上語言。甚至包括 JSON 鍵值、YAML 路徑和 TOML 表格。
PythonSwiftTypeScriptJavaScriptRustGoRubyJavaKotlinCC++C#HaskellElixirScalaRJuliaPerlPHPDartZigVOCamlJSONYAMLTOMLXMLPlistCSSShell
準備好體驗永不過時的文件了嗎？
下載 Mac 版本