使用自述文件

上传一个 README.md 文件，其中包含工作流程的说明、图表和基本信息。每个工作流程版本都支持一个 README 文件，可以随时更新。

自述文件要求包括：

• 自述文件必须采用 markdown (.md) 格式

• 最大文件大小：500 KiB

使用现有的自述文件

READMEs 从 Git 存储库导出的内容包含相对链接，这些链接通常在仓库之外不起作用。 HealthOmics Git 集成会自动将这些链接转换为绝对链接，以便在控制台中正确呈现，无需手动更新 URL。

对于从 Amazon S3 或本地驱动器 READMEs 导入的图像和链接，必须使用公共文件 URLs 或更新其相对路径才能正确呈现。

注意

图片必须公开托管才能显示在 HealthOmics 控制台中。存储在GitHub Enterprise Server或存储GitLab Self-Managed库中的图像无法呈现。

渲染条件

HealthOmics 控制台使用绝对路径插值可公开访问的图像和链接。要 URLs 从私有仓库进行渲染，用户必须有权访问存储库。对于GitHub Enterprise Server或使用自定义域名的GitLab Self-Managed存储库， HealthOmics 无法解析相对链接，也无法呈现存储在这些私有存储库中的图像。

下表显示了 AWS 控制台自述文件视图支持的 markdown 元素。

元素	AWS 控制台
警报	是的，但没有图标
徽章	是
基本文本格式	是
代码块	是的，但没有语法突出显示和复制按钮功能
可折叠部分	是
标题	是
图像格式	是
图片（可点击）	是
换行符	是
美人鱼图	只能打开图表、移动图表位置和复制代码
报价	是
下标和上标	是
表	是，但不支持文本对齐
文本对齐方式	是

使用图片和链接 URLs

根据您的来源提供商，请按以下格式构建页面和图像的基础 URLs 。

• {username}：存储库所在的用户名。

• {repo}：存储库名称。

• {ref}: 源引用（分支、标签和提交 ID）。

• {path}：存储库中页面或图像的文件路径。

源提供商	页面网址	图片网址
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}

GitHubGitLab、，并Bitbucket支持链接到公共存储库 URLs 的页面和图像。下表显示了每个源提供商对私有仓库渲染图像和链接 URLs 的支持。

私有存储库支持
源提供商	页面网址	图片网址
GitHub	只能访问存储库	否
GitLab	只能访问存储库	否
Bitbucket	只能访问存储库	否