自訂文件外觀

第一印象很重要。當開發者造訪您的 API 文件時，他們會透過文件的品質來判斷您 API 的品質。一個通用、無品牌的頁面暗示著一個通用的產品。一個品牌化、精緻的頁面暗示著一個專業、可靠的服務。

Apidog 允許您自訂文件網站的外觀和感覺，以符合您公司的識別，而無需編寫程式碼。

品牌基礎要素

前往 Share Docs > Publish > Edit > Appearance。

1. Logo 和 Favicon

將預設的 Apidog Logo 替換為您自己的。

Logo：用於頂部導覽列。

Favicon：瀏覽器標籤中的小圖示。

2. 主色調

選擇您品牌的主色調。這將影響文件中的按鈕、連結和活動狀態。

根據您的品牌指南，嘗試將其設定為深藍色（例如 #0052CC）或充滿活力的綠色。

3. 深色模式

開發者喜歡深色模式。Apidog 開箱即支援它。您可以：

強制淺色模式。

強制深色模式。

自動 (推薦)：跟隨使用者的系統偏好設定。

版面配置與導覽

良好的文件易于導覽。您不希望使用者迷失在端點的海洋中。

頂部導覽

您不僅限於 API 參考頁面。您可以在頂部導覽列新增有用的連結：

連結：外部連結（例如「支援」、「GitHub Repo」、「狀態頁面」）。

資料夾：將多個相關連結分組。

下拉選單：用於複雜的階層結構。

目錄樣式

選擇側邊欄的行為方式。

雙欄佈局：經典文件風格。側邊欄在左側，內容在右側。

三欄佈局：在右側新增「本頁內容」目錄，以便在單一頁面內進行深度導覽。

查看詳情自訂佈局

建立登陸頁面

預設首頁通常只是第一個端點。您可以建立一個專門的 Landing Page 來歡迎使用者。

在您的專案中建立一個 Markdown 文件（例如 "Welcome.md"）。

寫一個清晰的介紹：

「歡迎來到 Pet Store API。」

「這是如何進行身分驗證...」

「查看我們的快速入門指南。」

在發布的文件設定中，將此文件設定為 Home Page。

這充當了您 API 產品的「前門」。

重點摘要

品牌很重要：自訂 Logo、Favicon 和主色調，使您的文件看起來像是您產品的無縫組成部分。

導覽：使用頂部導覽列連結到外部資源，如支援頁面或 GitHub Repos。

登陸頁面：建立專門的歡迎頁面來引導使用者，而不是將他們直接丟進端點參考中。

自訂佈局：在雙欄或三欄佈局之間選擇，以最佳化閱讀體驗。

在下一節中，我們將確切地看到那些「Try it out」按鈕是如何運作的，以及它們如何將您的靜態文件轉變成一個互動式控制台上。

繼續閱讀 → 給消費者的互動功能

品牌基礎要素#

1. Logo 和 Favicon#

2. 主色調#

3. 深色模式#

版面配置與導覽#

頂部導覽#

目錄樣式#

建立登陸頁面#

重點摘要#