Slate:建立漂亮的靜態 API 文件開源工具

Slate 幫助你建立漂亮的、聰明的、響應式的 API 文件。

這個工具有以下特色

乾淨,直覺的設計

在 Slate 中,API 的描述位於文件的左側,所有程式碼範例都位於右側。 靈感來自 Stripe 和 PayPal 的 API 文件。 平板電腦反應靈敏,所以在平板電腦、手機甚至列印出來看起來都很棒。

所有的內容都在一個單一網頁中

使用者必須在一百萬個頁面中搜索才能找到他們想要的東西的日子已經一去不復返了。 Slate 將整個文件放在一個頁面上。 但是並沒有犧牲可連結性。 當你滑動網頁時,你的瀏覽器會更新到最近的標題,因此連結到文件中的特定點仍然是自然而簡單的。

支援 Markdown

當你用 Slate 寫 API 文件的時候,你只是在寫 Markdown,這使得編輯和理解變得很簡單。 一切都是用 Markdown 編寫的ーー甚至程式碼範例也只是 Markdown 程式碼區塊。

可支援多種語言呼叫 API 的程式碼範例

如果你的 API 有多種程式語言的連結,你可以很容易地在它們之間加入標籤進行切換。 在你的文件中,您將通過在每個程式碼區塊頂部指定程式語言名稱來區分不同的語言,就像 GitHub flavary Markdown 一樣。

超過 100 種程式語言的語法 highlighting

無須特別的設定

在左邊網頁自動流暢的 table 內容捲動

當你捲動網頁時,它會顯示你當前在文件中的位置。 它也很快。

讓你的使用者為你更新文件

預設情況下,您的 slate 生成的文件託管在一個公共 GitHub 儲存庫中。 這不僅意味著你可以通過 GitHub Pages 免費託管你的文件,而且還可以讓其他開發者在發現文件打字錯誤或其他問題時,很容易地向你的文件發出請求。 當然,如果你不想使用 GitHub,你也可以在其他地方託管你的文件。

RTL 支援

右邊寫到左邊的語言,例如阿拉伯語

目前已經有多家知名的公司在使用這個工具

✍ 專案網址 https://github.com/slatedocs/slate

API 相關線上課程/電子書

🌳未來有跟這個專案的補充資訊會放到 FB 貼文的留言區,有興趣可按讚追蹤

 歡迎使用 App / Email | Telegram 訂閱 網站更新

這個網站採用 Akismet 服務減少垃圾留言。進一步瞭解 Akismet 如何處理網站訪客的留言資料

Powered by WordPress.com.

Up ↑

%d 位部落客按了讚: