ReadMe 整合
透過螢幕錄影將開發者指南發佈至 ReadMe
您的 API 參考文件負責解釋端點，而您的指南則負責解釋周邊的一切。錄製一次流程，Clevera 就會自動撰寫包含截圖的指南，並發佈至您選擇的 ReadMe 開發者中心指南類別中。
開發者中心內的指南
ReadMe 標註與程式碼分頁
截圖已上傳至 ReadMe
依網址更新
您可以做什麼
圍繞 API 的指南，
直接從產品本身撰寫。
開發者進入您的 ReadMe 中心以開始使用：建立帳戶、尋找 API 金鑰、設定 Webhook、在儀表板中測試。這些頁面充滿了截圖與點擊步驟，且每當儀表板更新時就會過時。Clevera 會根據錄影內容為您撰寫這些指南。
入門指南，點擊步驟一目了然
錄製從註冊到第一次 API 呼叫的儀表板操作路徑。Clevera 會將其轉化為包含編號步驟與對應截圖的指南。
程式碼保持原樣
程式碼區塊會保留其語言與標題。僅包含程式碼的分頁會變為 ReadMe 程式碼分頁，讓 cURL、Node 與 Python 範例並排顯示。
歸檔至開發者瀏覽處
選擇一個指南類別（例如「入門」或「Webhooks」），指南就會出現在您中心內的「指南」區塊中。
截圖由 ReadMe 託管
截圖會上傳至 ReadMe，因此即使您在 Clevera 中刪除該文章，指南依然能正常運作。
儀表板變更時更新指南
重新錄製流程、更新 Clevera 中的文章並再次發佈。Clevera 會透過網址找到該指南並進行原地覆蓋。
相容 ReadMe 頁面格式
文字中的大括號與角括號會自動跳脫，因此像這樣的佔位符 {API_KEY} 會精確顯示。
運作方式
從錄影到 ReadMe 指南
只需四個步驟。
輸入一次專案的 API 金鑰。之後，工作區中的任何文章都可以成為您中心內的指南。
- 1
連接您的專案
從 ReadMe 專案的「設定」複製 API 金鑰，貼上至 Clevera 並讓系統驗證金鑰。 - 2
Clevera 撰寫指南
根據您的螢幕錄影，Clevera 會撰寫指南：包含步驟、截圖、標註與程式碼。 - 3
選擇指南類別
在「分享」中開啟「發佈」，選擇指南類別並點擊「發佈至 ReadMe」。 - 4
出現在您的指南中
指南會出現在您專案主版本中該類別下，網址則由標題自動生成。
在 Clevera 中查看
發佈至 ReadMe，
從文章的「分享」視窗。
無需貼上至 ReadMe 編輯器、無需逐一上傳截圖、無需在 ReadMe 語法中重寫標註。「分享」視窗會為您完成發佈。
一個金鑰，一個專案
在 ReadMe 中，開啟您專案的 Configuration → API Keys 並複製金鑰。貼上至 Clevera 並點擊 Check key；Clevera 會在儲存任何內容前顯示該金鑰所屬的專案。
該金鑰擁有對專案的完整存取權，請妥善保管。若要發佈至不同專案，請使用該專案的金鑰重新連接。
選擇指南類別
Project 顯示已連接的中心。選擇一個 Guide category：指南將進入「指南」區塊中該類別下。還沒有類別嗎？請先在 ReadMe 中建立一個。
網址由標題生成，因此「Create your first API key」會變成 /docs/create-your-first-api-key.
為您自動填寫
進入開發者中心的內容
以及您的決定。
Clevera 將文章轉換為 ReadMe 的頁面格式，因此指南會使用 ReadMe 的標註、程式碼區塊與嵌入內容，並可像其他頁面一樣在 ReadMe 中編輯。
- 指南類別由您選擇
- 您專案「指南」中的任何類別。Clevera 會發佈至您文件的主要（穩定）版本。
- 標題與網址為您設定
- 文章標題，以及在
/docs/下生成的網址。如果該網址已被佔用，ReadMe 會為新指南提供一個略有不同的網址。 - 可見度由您決定
- Clevera 不會設定可見度，因此新指南會採用 ReadMe 的預設值：公開。如果您想先審閱，發佈後可在 ReadMe 中更改。更新時會保留指南現有的可見度設定。
- 標註為您轉換
- 帶有標題的 ReadMe 標註：📘 用於資訊與備註，👍 用於提示與成功，🚧 用於警告，❗️ 用於危險。
- 程式碼與分頁為您轉換
- 程式碼區塊保留其語言與標題。僅包含程式碼的分頁會變為 ReadMe 程式碼分頁；其他分頁則變為帶標題的區塊。
- 步驟與切換為您轉換
- 編號步驟會變為帶有粗體標題的編號清單。可摺疊區塊會變為 ReadMe 的展開式區塊。
- 截圖與影片為您設定
- 截圖會連同標題上傳至 ReadMe。文章中的影片會變為 ReadMe 嵌入內容；Clevera 影片需開啟分享連結。
設定
設定 ReadMe 整合
只需約兩分鐘。
您需要一個 Pro 或以上等級的 Clevera 工作區，以及一個已啟用 ReadMe Refactored 且至少有一個指南類別的 ReadMe 專案。工作區擁有者或管理員只需連接一次 ReadMe；之後，任何可以編輯文章的人都可以發佈。發佈過程不消耗額度。
- 1
複製 ReadMe API 金鑰
在您的 ReadMe 專案中，開啟 Configuration → API Keys 並複製金鑰，若清單為空則建立一個。 - 2
在 Clevera 中連接 ReadMe
開啟工作區選單，選擇 Integrations，找到 ReadMe 並點擊 Connect。將金鑰貼上至 API key 並點擊 Check key. - 3
確認專案
當您看到「Key accepted.」以及您在 Sites to publish to下的專案時，點擊 Connect. - 4
發佈文章
在文章編輯器中，點擊 Share，開啟 Publish，點擊 ReadMe 圖示，選擇一個 Guide category 並點擊 Publish to ReadMe. - 5
在 ReadMe 中開啟
當您看到「Published to ReadMe.」時，點擊 Open in ReadMe，若指南尚未準備公開，請設定其可見度。
ReadMe 整合常見問題
它適用於 ReadMe Refactored 上的專案，因為 Clevera 使用 ReadMe 當前的 (v2) API。仍在使用 ReadMe 舊平台的專案無法連接。
不行。Clevera 發佈至「指南」區塊：即圍繞您參考文件的入門、操作指南與儀表板頁面。您的 API 參考頁面將保持不變。
您專案「指南」的主要（穩定）版本。
是的，預設為公開。Clevera 不會設定可見度，因此 ReadMe 會使用其預設值（公開）。如果您想先審閱，發佈後可在 ReadMe 中隱藏指南；後續更新會保留該可見度。
Clevera 會在您的「指南」中搜尋相同網址的指南，並顯示「This article is already in ReadMe.」。您可以選擇更新以覆蓋該網址的指南，或以新標題建立新指南。自上次發佈後在 ReadMe 中所做的變更將會被更新覆蓋。
不會。發佈是單向的，從 Clevera 到 ReadMe。當您在 Clevera 中編輯文章時，ReadMe 中的指南不會變更，直到您再次發佈為止。因此，請將 Clevera 中的文章作為任何顯示儀表板指南的原始來源。
工作區擁有者或管理員使用專案金鑰連接一次 ReadMe 後，任何可以編輯文章的人都可以發佈至 ReadMe，且無需看到金鑰。僅有檢視權限的人無法發佈。
可以，這是一項獨立的免費功能。請參閱 ReadMe import 與 Clevera 與 ReadMe 的比較。此整合專為將開發者中心保留在 ReadMe 上的團隊設計。
發佈至 ReadMe 是 Clevera Pro 與 Custom 方案的一部分，且不消耗額度；製作文章則照常消耗額度。請參閱 pricing.