跳到內容

術語表

TypeMD 文件、CLI 和設定檔中使用的術語快速參考。

由 TypeMD 管理的目錄。包含 .typemd/(設定)、objects/(內容),以及選填的 templates/(object template)。每個 Vault 都是獨立的,可以用版本控制管理。

TypeMD 中知識的基本單位。你不需要用「檔案」或「筆記」來思考,而是用物件——一本書、一個人、一個想法、一場會議。每個物件是一個 Markdown 檔案,包含 YAML frontmatter(屬性)和自由格式的內文。

深入了解 →

定義你要建立什麼樣的物件。每個物件只屬於一個類型(例如 bookpersonnote)。類型由 types/ 中的 YAML schema 檔案定義。可選的 schema 欄位包含 plural(集合情境的複數顯示名稱)、emojicolordescriptionversionunique

深入了解 →

物件上的具名欄位,由 Type schema 定義。屬性有型別(stringnumberdateselectrelation 等),儲存在 YAML frontmatter 中。屬性可以有 emojipindefault 等附加設定。

深入了解 →

兩個物件之間具名且帶型別的連結。不同於簡單的超連結,關聯定義在 Type schema 中,可以設定為雙向——更新一端會自動更新另一端。

深入了解 →

在 Markdown 內文中使用 wiki-link 語法([[...]])引用其他物件的方式。TypeMD 會追蹤這些連結及其反向連結(backlink)。也稱為 wiki-link

深入了解 →

從連結自動計算的反向參照。如果物件 A 連結到物件 B,則 B 有一個來自 A 的反向連結。反向連結是唯讀的,由索引自動維護。

深入了解 →

內建 tag 類型的物件。標籤強制 name 唯一性,可以透過 tags 系統屬性連結到任何物件。標籤支援 coloricon 屬性。

深入了解 →

建立新物件時提供預設 frontmatter 和內文。Object template 以 Markdown 檔案儲存在 templates/<type>/ 中。Name template 使用 {{ date:FORMAT }} 語法自動產生物件名稱。

深入了解 →

已儲存的設定,控制某個 Type 的物件如何顯示 — 包含排序順序、篩選規則、分組和佈局。View 以 YAML 檔案儲存在 types/<name>/views/。每個 Type 都有一個隱含的預設 View(list 佈局,按 name 排序)。

深入了解 →

物件檔名中人類可讀的部分。例如 book/golang-in-action-01jqr3k5mpbvn8e0f2g7h9txyz.md 中的 golang-in-action。來自建立物件時提供的名稱。

建立物件時使用自然語言名稱(例如 “Clean Code”),TypeMD 會依以下規則轉換為 slug:

  1. 轉換為小寫
  2. 空格和底線替換為連字號
  3. 移除非字母、數字和連字號的字元(CJK 和帶重音的 Unicode 字母會保留)
  4. 將連續的連字號合併為單一連字號
  5. 去除開頭和結尾的連字號
輸入Slug
Clean Codeclean-code
What's the plan?whats-the-plan
my_great_ideamy-great-idea
Chapter 3 Noteschapter-3-notes
clean-codeclean-code(已是合法格式)

原始輸入一律保留在 name 屬性中——slug 轉換只影響檔名。

26 字元的通用唯一且可按字典序排列的識別碼(Universally Unique Lexicographically Sortable Identifier),由 CLI 自動附加在 slug 後方。確保即使 slug 相同也不會衝突。手動建立的物件不需要 ULID。

物件的完整識別碼,格式為 type/slug-ulid。例如:book/golang-in-action-01jqr3k5mpbvn8e0f2g7h9txyz。用於連結目標和關聯參照。

Object ID 去除 ULID 後綴的人類可讀形式。例如:從 book/golang-in-action-01jqr3k5mpbvn8e0f2g7h9txyz 得到 book/golang-in-action。用於渲染沒有顯示文字的 wiki-link。

物件檔案頂部的 YAML 中繼資料區塊,以 --- 分隔。依固定順序包含屬性:系統屬性在前,schema 定義的屬性在後。

深入了解 →

SQLite 資料庫(.typemd/index.db),快取物件中繼資料以供快速查詢和全文搜尋。自動建立和更新,不需要手動編輯。

讀取物件檔案並更新索引的過程。開啟 Vault 時自動發生。同步時會補上缺少的 name 屬性、解析標籤參照、並重新整理搜尋索引。

檢查 schema、物件、關聯、連結和 name 唯一性約束是否正確。使用 tmd type validate 執行。

深入了解 →