本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# HealthOmics 工作流程自述文件
<a name="workflows-readme"></a>

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

**自述文件要求包括：**
+ 自述文件必须采用 markdown (.md) 格式
+ 最大文件大小：500 KiB

**Topics**
+ [使用现有的自述文件](#workflows-add-readme)
+ [渲染条件](#workflows-rendering-readme)

## 使用现有的自述文件
<a name="workflows-add-readme"></a>

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

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

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

## 渲染条件
<a name="workflows-rendering-readme"></a>

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

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


| 元素 | AWS 控制台 | 
| --- | --- | 
| 警报 | 是的，但没有图标 | 
| 徽章 | 是 | 
| 基本文本格式 | 是 | 
| [代码块](https://www.markdownguide.org/basic-syntax/#code-blocks) | 是的，但没有[语法突出显示](https://www.markdownguide.org/extended-syntax/#syntax-highlighting)和复制按钮功能  | 
| 可折叠部分 | 是 | 
| [标题](https://www.markdownguide.org/basic-syntax/#headings) | 是 | 
| [图像格式](https://www.markdownguide.org/basic-syntax/#images-1) | 是 | 
| [图片（可点击）](https://www.markdownguide.org/basic-syntax/#linking-images) | 是 | 
| [换行符](https://www.markdownguide.org/basic-syntax/#line-breaks) | 是 | 
| 美人鱼图 | 只能打开图表、移动图表位置和复制代码 | 
| 报价 | 是 | 
| [https://www.markdownguide.org/extended-syntax/#subscript](https://www.markdownguide.org/extended-syntax/#subscript) | 是 | 
| [表](https://www.markdownguide.org/extended-syntax/#tables) | 是，但不支持文本对齐 | 
| 文本对齐方式 | 是 | 

### 使用图片和链接 URLs
<a name="workflows-urls-readme"></a>

根据您的来源提供商，请按以下格式构建页面和图像的基础 URLs 。
+ `{username}`：存储库所在的用户名。
+ `{repo}`：存储库名称。
+ `{ref}`: 源引用（分支、标签和提交 ID）。
+ `{path}`：存储库中页面或图像的文件路径。


| 源提供商 | 页面网址 | 图片网址 | 
| --- | --- | --- | 
| GitHub | https://github.com/\$1username\$1/\$1repo\$1/blob/\$1ref\$1/\$1path\$1 |  `https://github.com/{username}/{repo}/blob/{ref}/{path}?raw=true` `https://raw.githubusercontent.com/{username}/{repo}/{ref}/{path}`  | 
| GitLab | https://gitlab.com/\$1username\$1/\$1repo\$1/-/blob/\$1ref\$1/\$1path\$1 | https://gitlab.com/\$1username\$1/\$1repo\$1/-/raw/\$1ref\$1/\$1path\$1 | 
| Bitbucket | https://bitbucket.org/\$1username\$1/\$1repo\$1/src/\$1ref\$1/\$1path\$1 | https://bitbucket.org/\$1username\$1/\$1repo\$1/raw/\$1ref\$1/\$1path\$1 | 

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


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