使用 README 檔案

上傳包含工作流程指示、圖表和必要資訊的 README.md 檔案。每個工作流程版本都支援一個 README 檔案，可以隨時更新。

README 要求包括：

• README 檔案必須為 Markdown (.md) 格式

• 檔案大小上限：500 KiB

使用現有的 README

從 Git 儲存庫匯出READMEs 包含通常無法在儲存庫外部運作的相對連結。HealthOmics Git 整合會自動將這些連結轉換為絕對連結，以在主控台中正確轉譯，無需手動更新 URL。

對於從 Amazon S3 或本機磁碟機匯入READMEs，映像和連結必須使用公有 URLs或更新其相對路徑，以進行適當的轉譯。

注意

必須公開託管映像，才能在 HealthOmics 主控台中顯示。存放在 GitHub Enterprise Server或 GitLab Self-Managed 儲存庫中的影像無法轉譯。

轉譯條件

HealthOmics 主控台會使用絕對路徑插入可公開存取的影像和連結。若要從私有儲存庫轉譯 URLs，使用者必須能夠存取儲存庫。對於使用自訂網域的 GitHub Enterprise Server或 GitLab Self-Managed 儲存庫，HealthOmics 無法解析存放在這些私有儲存庫中的相對連結或轉譯映像。

下表顯示 AWS 主控台 README 檢視支援的 Markdown 元素。

Element	AWS 主控台
Alerts (提醒)	是，但沒有圖示
徽章	是
基本文字格式	是
程式碼區塊	是，但沒有語法反白和複製按鈕功能
可摺疊區段	是
標題	是
影像格式	是
影像 （可點選）	是
換行	是
美人魚圖	只有 可以開啟圖形、移動圖形位置和複製程式碼
引號	是
下標和上標	是
資料表	是，但不支援文字對齊
文字對齊	是

使用映像和連結 URLs

根據您的來源提供者，以下列格式建構頁面和映像的基本 URLs。

• {username}：託管儲存庫的使用者名稱。

• {repo}：儲存庫名稱。

• {ref}：來源參考 （分支、標籤和遞交 ID)。

• {path}：儲存庫中頁面或映像的檔案路徑。

來源提供者	頁面 URL	影像 URL
GitHub	https://github.com/{username}/{repo}/blob/{ref}/{path}	https://github.com/{username}/{repo}/blob/{ref}/{path}?raw=true https://raw.githubusercontent.com/{username}/{repo}/{ref}/{path}
GitLab	https://gitlab.com/{username}/{repo}/-/blob/{ref}/{path}	https://gitlab.com/{username}/{repo}/-/raw/{ref}/{path}
Bitbucket	https://bitbucket.org/{username}/{repo}/src/{ref}/{path}	https://bitbucket.org/{username}/{repo}/raw/{ref}/{path}

GitHub、 GitLab和 Bitbucket支援連結至公有儲存庫的頁面和映像 URLs。下表顯示每個來源提供者對私有儲存庫轉譯映像和連結 URLs的支援。

私有儲存庫支援
來源提供者	頁面 URL	影像 URL
GitHub	只能存取 儲存庫	否
GitLab	只能存取 儲存庫	否
Bitbucket	只能存取 儲存庫	否