GitLab 整合
將螢幕錄製內容轉為 GitLab 中的 Markdown 文件
錄製一次工作流程。Clevera 會撰寫圖文並茂的指南，並將其作為 Markdown 檔案與截圖提交至您選擇的 GitLab 專案與資料夾，讓您的 docs-as-code 管線能像處理其他變更一樣自動接收。
GitLab 風格 Markdown
截圖已提交至專案
支援 GitLab Pages 與 MkDocs
發佈無需點數
您可以做什麼
Docs as code，
無需任何人手動撰寫文件。
使用 GitLab 的團隊早已將文件視為程式碼：它存在於專案中、擁有版本紀錄，並透過管線發佈。困難的部分從來不是管線，而是撰寫指南。Clevera 從螢幕錄製中撰寫指南，並將其放入您的管線所讀取的資料夾中。
每個操作步驟都有指南
在螢幕上展示一次功能。Clevera 會將錄製內容轉為包含編號步驟與截圖的教學文件，隨時可放入專案手冊或產品文件中。
您的管線負責其餘工作
每次發佈都是預設分支上的一次正常提交，因此 GitLab Pages、MkDocs 或 Hugo 會像處理團隊成員的變更一樣重新建置網站。
圖片存在於專案中
截圖會與 Markdown 檔案一同提交，並透過相對路徑連結。它們不依賴 Clevera，且私人專案會確保其隱私。
更新即為可讀的提交
在 Clevera 中修正文章並再次發佈。相同的檔案及其圖片會在「更新文章」的提交中被覆寫，因此歷史紀錄會顯示變更內容與時間。
任何專案，任何資料夾
從已連結帳號擁有 Developer 或更高權限的每個 GitLab 專案中選擇，並輸入資料夾： docs, handbook/support 或是專案根目錄。
遵循您的分支規則
Clevera 會尊重受保護的分支。如果只有 Maintainer 可以推送到 main，請連結 Maintainer 帳號或允許 Developer 推送。
運作方式
從錄製到 GitLab 專案
只需四個步驟。
擁有者或管理員只需連結一次 GitLab。之後，任何可以編輯文章的人都能從編輯器中發佈。
- 1
連結 GitLab.com
登入 GitLab 並授權 Clevera。它會列出您帳號擁有 Developer 或更高權限的專案。 - 2
Clevera 撰寫指南
根據螢幕錄製內容，Clevera 會撰寫說明文章：標題、編號步驟、提示框與截圖。 - 3
選擇專案與資料夾
在「分享」中開啟「發佈」，選擇 GitLab 專案與資料夾，然後點擊「發佈至 GitLab」。 - 4
完成一次提交
Markdown 檔案與圖片會一同在預設分支上進行一次提交，隨後您的管線便會執行。
在 Clevera 中查看
發佈至 GitLab，
從文章的「分享」視窗。
無需匯出、無需手動複製 Markdown、無需將截圖拖曳至儲存庫。提供連結與嵌入程式碼的「分享」視窗，同時也能提交至 GitLab。
選擇專案與資料夾
清單會顯示已連結的 GitLab 帳號擁有 Developer 或更高權限的專案，並依最近更新排序。輸入您文件所在的資料夾，例如 docs/guides；尚未存在的資料夾會在同一次提交中建立。
Clevera 會記住專案與資料夾，因此下一篇文章會發佈到相同位置。
重新發佈而不產生重複檔案
在撰寫前，Clevera 會檢查該資料夾中是否有同名檔案。如果找到，您可以選擇：在新的提交中覆寫它，或保留它並以新標題發佈此版本。
發佈僅為單向。任何人在 GitLab 中對檔案所做的編輯，都不會回流至 Clevera 文章中。
GitLab 與您的其他技術堆疊並存
有些團隊將產品文件放在 GitLab，而內部維基放在其他地方。連結每個工具一次，即可從同一個分頁將同一篇文章發佈至 GitLab、 Confluence 或 Notion 。
為您自動填寫
每次提交包含的內容
以及您決定的事項。
Clevera 撰寫的 Markdown 可在 GitLab 的檔案檢視中呈現，並能由靜態網站產生器乾淨地建置。以下是發佈內容放入您專案中的確切細節。
- 專案與資料夾由您選擇
- 任何已連結帳號擁有 Developer 或更高權限的 GitLab.com 專案，以及其中的任何資料夾。資料夾預設為
docs；若留空則為專案根目錄。 - 檔案名稱為您設定
- 文章標題的小寫形式，以連字號連接，並以
.md結尾。「Reset a customer password」會變成reset-a-customer-password.md。帶有重音符號與非拉丁語系的標題會以拉丁字母拼寫，名稱長度限制為 80 個字元。 - Front matter為您設定
- 包含
title,created_at,updated_at與source的 YAML 區塊。MkDocs、Hugo 與 Docusaurus 會讀取標題並忽略其餘部分。 - 提示框與格式為您轉換
- 提示框會變成 GitLab 警示，標題位於同一行，例如
> [!WARNING] Careful。表格、任務清單、數學公式、帶有語言標記的程式碼區塊以及可摺疊的<details>區段都會依照 GitLab 的呈現方式顯示。 - 截圖為您設定
- 提交至
assets/<file name>/，位於相同資料夾與同一次提交中，每個說明文字會以斜體顯示在圖片下方。 - 提交為您設定
- 在預設分支上進行一次提交，訊息為
Add article: …或Update article: …，由連結 Clevera 的 GitLab 帳號進行署名。 - 影片為您設定
- 放入文章中的影片會變成連結至播放器的海報圖片，外加一個帶有標題的 ▶ 連結。文章來源的錄製檔不會被加入。
設定
設定 GitLab 整合
只需約兩分鐘。
您需要一個 Pro 或 Custom 方案的 Clevera 工作區以及一個 GitLab.com 帳號。工作區擁有者或管理員負責連結 GitLab；之後，任何可以編輯文章的人都能發佈。發佈無需消耗點數。
- 1
開啟整合
在 Clevera 中，開啟工作區選單，選擇 Integrations，在 Code repositories 下方找到 GitLab 並點擊 Connect. - 2
在 GitLab.com 上授權 Clevera
GitLab 會要求 api, read_user, read_repository 與 write_repository 權限範圍，這是其檔案 API 建立與更新檔案所需的。點擊 Authorize. - 3
檢查權限角色
在每個專案中使用擁有 Developer 或更高權限的帳號。若要提交至受保護的預設分支，通常需要 Maintainer權限；使用共享的機器人帳號效果良好。 - 4
發佈文章
在文章編輯器中，點擊 Share，開啟 Publish，點擊 GitLab 圖示，選擇專案與資料夾，然後點擊 Publish to GitLab. - 5
在 GitLab 中開啟
當您看到「Published to GitLab.」時，點擊 Open in GitLab 即可查看檔案與提交內容。
GitLab 整合常見問題
目前不支援。Clevera 僅連接至 GitLab.com。不支援自架 GitLab 伺服器，因此您自己的 GitLab 執行個體上的專案無法作為發佈目標。
不會。Clevera 直接提交至專案的預設分支（通常為 main），且您無法選擇其他分支。如果您的團隊透過合併請求審核文件，請在發佈前於 Clevera 中審核文章，或發佈至允許直接提交的專案。
幾乎都是因為受保護的分支。GitLab 會保護預設分支，通常只允許 Maintainer 推送。請給予已連結帳號 Maintainer 角色，或在 Settings → Repository → Protected branches.
我可以發佈至 GitLab Pages、MkDocs 或 Hugo 嗎？ title 可以。將資料夾指向您網站建置的來源資料夾即可。每次發佈都是一次正常提交，因此您的 CI/CD 管線會照常執行，產生器也會讀取 front matter 中的內容。請檢查您的主題是否能正確呈現提示框與可摺疊區段。
在您再次發佈之前，GitLab 中的內容不會有任何變更。之後，Clevera 會找到現有檔案並讓您透過新的 commit 進行更新。如果您重新命名了文章，新標題將成為一個新檔案；請自行在 GitLab 中刪除舊檔案。Clevera 絕不會從您的專案中刪除任何檔案。
一個工作區僅能維持一個 GitLab 連接，再次連接將會取代先前的設定。請使用身為您所有發佈專案成員的帳號進行連接。
發佈至 GitLab 包含在 Pro 與 Custom 方案中，且發佈過程不會消耗點數。製作文章本身則照常消耗點數。請參閱 定價方案.