跳至內容
Clevera Help Center

發布文章到 GitHub

連接 GitHub 並將任何 Clevera 文章及其螢幕截圖以 Markdown 檔案格式,發布到你選擇的儲存庫和資料夾中:包含權限、檔案名稱、前言 (front matter)、圖片、更新和錯誤訊息。

更新於 閱讀時間 4 分鐘

連接一次 GitHub,你就可以將任何 Clevera 文章以 Markdown 檔案形式發布到儲存庫中,隨時可用於文件網站、Wiki 風格的 docs/ 資料夾或 README 集合。本文涵蓋了連接方式、選擇儲存庫與資料夾、檔案外觀以及更新運作方式。

開始之前

  • 方案: 發布到 GitHub 是 Pro 和 Custom 方案的一部分。在 Free 和 Starter 方案中,發布標籤頁會顯示「發布到你的工具包含在 Pro 方案中」。請參閱 選擇方案。
  • 在 Clevera 中的角色: 只有工作區擁有者或管理員可以連接或中斷連接 GitHub。一旦連接,任何可以編輯文章的人都可以發布它。
  • GitHub 中的存取權限: 進行連接的人員需要對你想要發布到的儲存庫擁有寫入權限,並有權在該個人帳戶或組織上安裝 GitHub App(或由組織擁有者批准)。
  • 文章: 你可以發布屬於影片或錄製內容的文章。請先生成它;請參閱 將錄製內容轉為文章。

發布不會消耗點數。

連接 GitHub

  1. 開啟整合

    在側邊欄中,開啟工作區選單並選擇整合。在可用整合(或開發標籤頁)下找到 GitHub,然後點擊連接。當你將游標指向該卡片時,按鈕就會出現。

    開發標籤頁上的整合頁面,GitHub 卡片上顯示連接
    只有擁有者和管理員能看到連接。
  2. 在 GitHub 上授權 Clevera

    GitHub 會要求你授權 Clevera AI 應用程式。它會請求讀取你組織成員資格的權限,以便 Clevera 列出你所屬的帳戶。點擊授權。

  3. 在你的儲存庫上安裝應用程式

    接著 GitHub 會開啟 Clevera AI 應用程式安裝頁面。選擇你的個人帳戶或組織,然後選擇所有儲存庫或僅選擇儲存庫。該應用程式會要求以下權限:

    GitHub 權限 原因
    內容:讀取與寫入 用於建立和更新 Markdown 檔案及其圖片
    中繼資料:唯讀 GitHub 要求每個應用程式皆需此權限;讓 Clevera 可以列出儲存庫

    點擊安裝。對每個你想要發布到的組織重複此步驟。

  4. 檢查連接

    回到整合頁面,GitHub 會移至已連接列表,並顯示你的 GitHub 帳戶或組織名稱以及已連接徽章。在發布任何內容之前,它會顯示「尚未發布任何內容」。

    GitHub 列在 acme-inc 帳戶的已連接下方,且尚未發布任何內容

稍後新增或移除儲存庫

Clevera 僅能看到已安裝應用程式的儲存庫。若要更改此設定,請開啟整合,點擊 GitHub,並在存取權限下點擊儲存庫存取權。在 GitHub 上,開啟該帳戶,點擊設定並更改儲存庫列表。新的儲存庫會在下次開啟發布標籤頁時顯示。

帶有儲存庫存取權連結的 GitHub 連接詳細資訊
儲存庫存取權會開啟 GitHub,你可以在那裡選擇 Clevera 可以看到的儲存庫。

發布文章

  1. 開啟發布標籤頁

    在編輯器中,點擊分享並開啟發布標籤頁。在發佈文章下方,點擊準備發布下的 GitHub 圖塊。

    文章將以你在編輯器中開啟的語言進行發布。若要發布翻譯版本,請先在頂部列切換語言。

  2. 選擇帳戶、儲存庫和資料夾

    在發布位置下方,選擇:

    欄位 選擇內容 備註
    帳戶 你的個人帳戶或組織 僅在你的儲存庫屬於多個帳戶時顯示
    儲存庫 檔案所在的儲存庫 按最近更新排序。第一個會預設為你選定
    資料夾 路徑,例如 docs 或 articles/guides 「Markdown 檔案將在此處建立。留空則位於儲存庫根目錄。」預設為 docs。尚未存在的資料夾將會被建立

    Clevera 會記住你下次的選擇。

    發布到 GitHub 表單,包含 docs-site 儲存庫和 docs 資料夾
    檔案將進入儲存庫的預設分支,位於你輸入的資料夾中。
  3. 發布

    點擊發布到 GitHub。你會看到「正在 GitHub 中尋找現有副本」,然後是正在寫入頁面。完成後,你會看到「已發布到 GitHub」。點擊在 GitHub 中開啟以查看檔案。

    你可以在執行時關閉分享視窗;完成後會有通知提醒你。

檔案去向

  • 分支: 儲存庫的預設分支(通常為 main)。Clevera 直接提交至該分支;它不會開啟 Pull Request,且你無法選擇其他分支。
  • 檔案名稱: 標題的小寫形式,空格轉換為連字號,並以 .md 結尾。「Create your first invoice」會變成 create-your-first-invoice.md。其他語言或帶有重音符號的標題會先轉寫為拉丁字母(「Créer une facture」會變成 creer-une-facture.md)。若標題無法轉寫(例如僅由表情符號組成),則會獲得一個簡短的固定代碼(article- 加上 8 個字元)。名稱會在 80 個字元處截斷。
  • 圖片: 文章的螢幕截圖會放在同一資料夾內的 assets/<file name>/ 中,並在同一次提交中完成。
  • 提交訊息: Add article: <title>,或在更新現有檔案時為 Update article: <title>。
  • 提交作者: 連接整合的 GitHub 帳戶。

檔案外觀

Clevera 會編寫 GitHub 風格的 Markdown,並在頂部包含一個簡短的前言區塊:

Front matter
---
title: "Create your first invoice"
created_at: "2026-10-12T09:30:00+00:00"
updated_at: "2026-10-12T10:05:00+00:00"
source: "Clevera"
---
在 Clevera 文章中 在 Markdown 檔案中
標題、粗體、斜體、刪除線、行內程式碼 標準 Markdown
連結 保留。指向其他 Clevera 頁面的連結僅保留文字,因為它們在儲存庫中無法運作
項目符號、編號和巢狀列表 標準 Markdown 列表
核取清單 任務列表 (- [ ] / - [x])
表格 Markdown 表格
程式碼區塊 帶有語言標記的圍欄式程式碼區塊;程式碼標題會變成上方的一行粗體文字
提示框 (Callouts) GitHub 警示:info 和 note 為 [!NOTE],tip 和 success 為 [!TIP],warning 為 [!WARNING],danger 為 [!CAUTION]。標題在警示框內顯示為粗體
編號步驟 編號列表:每個步驟的標題為粗體,內容巢狀於其下
頁籤 (Tabs) 每個頁籤的標籤為粗體,後接其內容
切換開關 (Toggles) 可摺疊的 <details> 區段
卡片 帶有描述的連結列表;卡片圖示會被省略
螢光筆、上標、下標 <mark>、<sup> 和 <sub> 標籤,GitHub 會進行渲染
方程式 GitHub 數學公式 ($…$ 和數學區塊)
螢幕截圖與圖片 提交至儲存庫的圖片檔案,標題以斜體顯示
影片與嵌入內容 連結至影片的海報或 YouTube 縮圖,加上帶有標題的 ▶ 連結

文章來源的影片不會被加入檔案中。放置在文章內的 Clevera 影片僅在該影片的分享連結開啟時,才會變成指向其播放器的連結。請參閱 在文章中顯示影片。

圖片

螢幕截圖會與檔案一起提交到你的儲存庫,Markdown 透過相對路徑 (assets/<file name>/…) 連結到它們。即使沒有 Clevera,它們也能正常運作;在私人儲存庫中,它們會與其他內容一樣保持私密。

你上傳到文章中的影片檔案不會被提交。它會保持為一個會過期的 Clevera 連結;請再次發布以更新它。

與文件網站搭配使用

大多數從儲存庫建置的靜態網站產生器(如 Docusaurus、MkDocs、Jekyll 或 Hugo)會讀取前言中的 title 並忽略它們不認識的欄位。常見的設定方式:

  1. 將資料夾指向你的文件網站讀取的資料夾,例如 docs 或 content/guides。
  2. 將每篇文章發布到該處;你網站的正常建置程序會抓取新的提交。
  3. 檢查你的產生器是否渲染 GitHub 警示、數學公式和 <details>;有些產生器會將警示顯示為純引號。

更新已發布的文章

發布是單向的。你在 Clevera 中所做的編輯會保留在 Clevera 中,直到你再次發布;而在 GitHub 上對檔案所做的更改永遠不會回傳到 Clevera。

當你發布到同一個儲存庫和資料夾時,Clevera 會找到同名的檔案並顯示「此文章已存在於 GitHub」。點擊查看以開啟現有檔案,然後選擇:

選項 GitHub 上的結果 按鈕
更新現有文章 同一檔案及其圖片會在新的提交中被覆寫。 在 GitHub 中更新
建立新文章 「保留現有文章並以新標題新增此文章。」Clevera 會建議一個新標題,例如「Create your first invoice (2)」,這將成為一個新檔案。 建立新文章
GitHub 的重複提示:更新現有文章或建立新文章,並顯示在 GitHub 中更新

如果標題在 Clevera 中有所變更,檔案名稱也會隨之改變,因此發佈時會產生一個與舊檔案並存的新檔案。請自行在 GitHub 上刪除或重新命名舊檔案。

Clevera 中的任何操作都不會刪除您儲存庫中的檔案。

中斷 GitHub 連線

  1. 開啟 整合,點擊 GitHub 列上的 ⋯ 選單並選擇 中斷連線(或點擊 GitHub,然後點擊 中斷連線)。
  2. 確認。系統會顯示:「您將無法再從編輯器發佈至此。您已發佈的內容將保留在 GitHub 中。」

中斷連線會刪除 Clevera 的存取權杖。若要同時移除 Clevera 在 GitHub 上的存取權,請解除安裝 Clevera AI 應用程式(前往 GitHub 設定 → 應用程式 → 已安裝的 GitHub 應用程式 → 設定 → 解除安裝),並在 已授權的 GitHub 應用程式 下撤銷授權。

疑難排解

您看到的訊息 處理方式
「整合功能包含在 Pro 和自訂方案中。」 將工作區升級至 Pro 方案。請參閱 選擇方案。
整合頁面上沒有 連接 按鈕 只有擁有者或管理員可以進行連接。請詢問他們。
「您可以檢視此項目,但無法發佈。請詢問有編輯權限的人員。」 您需要該文章的編輯權限才能發佈。
「請先在整合頁面上連接 GitHub。」 此工作區尚未連接 GitHub。請詢問擁有者或管理員進行連接。
「此帳戶中沒有儲存庫。」 在該帳戶安裝 Clevera AI 應用程式,或透過 儲存庫存取權 新增儲存庫。如果之前已有儲存庫,請重新連線 GitHub。
清單中缺少某個儲存庫 檢查是否已在該儲存庫安裝 Clevera AI 應用程式。清單最多顯示 1,000 個儲存庫,並依最近更新排序。
「無法載入您的 GitHub 位置」 點擊 再試一次。如果問題持續發生,請重新連線 GitHub。
「無法發佈至 acme-inc/docs-site。」以及 GitHub 的說明 GitHub 拒絕了提交。通常是因為連接的帳戶無法推送至預設分支:需要提取請求 (pull request) 或審核的分支保護機制會阻擋此操作。請允許該提交,或發佈至沒有此規則的儲存庫。
「已達 GitHub 速率限制。請稍候片刻再試。」 等待一分鐘,然後點擊 再試一次。
「您的 GitHub 連線已過期。請重新連線 GitHub。」 點擊 重新連線,或開啟 整合 並點擊 GitHub 列上的 重新連線。
「連線失敗:」以及 GitHub 的原因 您拒絕了授權或 GitHub 拒絕了請求。請再次點擊 連接 並授權。
「無效的授權狀態。請再試一次。」或「授權已過期。請再試一次。」 登入時間過長或在其他分頁中執行。請從 連接 重新開始。
「連線嘗試次數過多。請稍後再試。」 請等待一分鐘;每分鐘最多可發起 5 次連線。
「文章內容為空或無效。」 該文章在此語言下沒有內容。請產生或撰寫內容後再發佈。
「找不到文章。請先產生文章。」 該影片在您開啟的語言中沒有對應文章。請產生文章或切換語言。
「發佈嘗試次數過多。請稍候片刻再試。」 每分鐘最多可發佈 20 次。請等待一分鐘。
「發佈至 GitHub 失敗。請再試一次。」 點擊 再試一次。如果持續失敗,請重新連線 GitHub 並聯絡支援團隊。
連線顯示 需要注意 或 錯誤 點擊該列上的 重新連線 並再次授權。