Markdown 文件

Apidog 不僅限於 API 文件，還允許你將豐富的 Markdown 內容直接整合到文件中。這讓你能建立完整的使用者指南，將 API 參考與說明文字、教學和範例無縫結合。Markdown 文件可以新增在多個層級，並與 API 文件並列顯示，提供完整的文件體驗。

獨立 Markdown 文件

點擊加號（+）按鈕，即可將獨立 Markdown 文件新增到任何端點資料夾。你可以在編輯器中撰寫 Markdown 內容，並立即在右側窗格中預覽渲染結果。

每個端點的 Description 欄位也支援 Markdown。你在這裡新增的任何 Markdown 都會在 API 文件中渲染為格式化文字，讓你的端點說明清楚且具有視覺吸引力。

在資料夾層級新增 Markdown 內容，以提供背景脈絡和概覽資訊。當讀者在文件中點擊資料夾名稱時，會看到該資料夾的 Markdown 內容。若沒有資料夾層級 Markdown，點擊資料夾只會展開它以顯示其內容。

新增資料夾層級 Markdown：

Apidog Markdown 支援各種擴充樣式，包括 Card、Accordion、Frame 等。這些自訂元件讓你能建立更豐富且更具互動性的文件體驗。

你可以透過 Markdown 編輯器輕鬆插入這些樣式，只要點擊 Insert 按鈕，即可看到可用元素的集合。

了解更多

深入了解 Apidog Markdown。