Slate

Slate 幫助您創建美觀、智慧、響應式的 API 文件。

功能

• 簡潔、直觀的設計 — 使用 Slate，您的 API 描述位於文件左側，所有程式碼範例則位於右側。靈感來自 Stripe 和 PayPal 的 API 文件。Slate 具有響應式設計，因此在平板電腦、手機甚至列印時看起來都很棒。

• 所有內容都在單一頁面上 — 使用者必須在數百萬個頁面中搜尋他們想要內容的日子已經過去了。Slate 將整個文件放在單一頁面上。不過，我們並未犧牲連結性。當您捲動時，瀏覽器的雜湊值會更新為最近的標題，因此連結到文件中的特定點仍然自然且容易。

• Slate 只是 Markdown — 當您使用 Slate 編寫文件時，您只是在編寫 Markdown，這使得編輯和理解變得簡單。所有內容都以 Markdown 撰寫 — 甚至程式碼範例也只是 Markdown 程式碼區塊。

• 以多種語言撰寫程式碼範例 — 如果您的 API 具有多種程式語言的綁定，您可以輕鬆放入索引標籤以在它們之間切換。在您的文件中，您可以透過在每個程式碼區塊的頂部指定語言名稱來區分不同的語言，就像使用 GitHub Flavored Markdown 一樣。

• 開箱即用的語法高亮顯示，支援 100 多種語言，無需設定。

• 頁面最左側自動、平滑捲動的目錄。當您捲動時，它會顯示您在文件中的目前位置。它也很快。我們正在 TripIt 使用 Slate 為我們的新 API 建構文件，我們的目錄有超過 180 個條目。我們確保即使對於較大的文件，效能仍然出色。

• 讓您的使用者為您更新文件 — 預設情況下，您使用 Slate 產生的文件託管在公開的 GitHub 儲存庫中。這不僅表示您可以使用 GitHub Pages 免費託管您的文件，而且也讓其他開發人員如果發現錯字或其他問題，可以輕鬆地對您的文件提出提取請求。當然，如果您不想使用 GitHub，也歡迎您將您的文件託管在其他地方。

• RTL 支援 完全支援由右至左的 RTL 語言佈局，例如阿拉伯語、波斯語（法語）、希伯來語等。

開始使用 Slate 非常簡單！只需 fork 這個儲存庫並按照以下說明操作。或者，如果您想查看 Slate 的功能，請查看範例文件。