前言

今天在網上發現了個不錯的開源的接口文檔工具slate，研究了一下並學習了一下如何安裝並使用它，開始的時候用的是原生的方式安裝使用的，但有些麻煩，所以試着用docker的方案安裝並記錄了一下安裝的過程分亨出來

一、Slate是什麼？

Slate 可幫助您創建美觀、智能、響應迅速的 API 文檔。

pulsar 單機docker_#容器

二、Slate特點

  • 簡潔、直觀的設計——使用 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 非常簡單！只需按下上方綠色的“使用此模板”按鈕，然後按照以下説明進行操作

三、Docker方式安裝Slate步驟

1. 在 Github 上 fork 這個存儲庫

。

2. clone Slate到本地

git clone https://github.com/YOURUSERNAME/slate.git

YOURUSERNAME 代表的是你的github 的帳號

3. 進入克隆後的代碼目錄

cd slate

4. 獲取 slate 映像或為存儲庫構建docker 映像

docker pull slatedocs/slate

或

docker build . -t slatedocs/slate

5. 用 Docker構建slate站點

docker run --rm --name slate -v $(pwd)/build:/srv/slate/build -v $(pwd)/source:/srv/slate/source slatedocs/slate build

6. 運行Slate服務

docker run --rm --name slate -p 4567:4567 -v $(pwd)/source:/srv/slate/source slatedocs/slate serve

## ```7. 訪問slate

```bash
 http://localhost:4567

總結

Slate讓我們直接可以用Markdown文檔寫接口文檔，非常不錯，有時間了大家可以試試