翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# HealthOmics ワークフロー README ファイル
<a name="workflows-readme"></a>

ワークフローの手順、図、重要な情報を含む README.md ファイルをアップロードできます。各ワークフローバージョンは 1 つの README ファイルをサポートしており、いつでも更新できます。

**README の要件は次のとおりです。**
+ README ファイルはマークダウン (.md) 形式である必要があります
+ 最大ファイルサイズ: 500 KiB

**Topics**
+ [既存の README を使用する](#workflows-add-readme)
+ [レンダリング条件](#workflows-rendering-readme)

## 既存の README を使用する
<a name="workflows-add-readme"></a>

Git リポジトリからエクスポートREADMEs には、通常リポジトリの外部では機能しない相対リンクが含まれています。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 コンソールの README ビューでサポートされているマークダウン要素を示しています。


| 要素 | 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) | はい | 
| Mermaid の図 | グラフを開き、グラフの位置を移動し、コードをコピーできるのは のみです | 
| 見積もり | はい | 
| [サブスクリプト](https://www.markdownguide.org/extended-syntax/#subscript)と[スーパースクリプト](https://www.markdownguide.org/extended-syntax/#superscript) | はい | 
| [テーブル](https://www.markdownguide.org/extended-syntax/#tables) | はい。ただし、テキストの整列はサポートされていません | 
| テキストの整列 | はい | 

### イメージ URL とリンク URLs
<a name="workflows-urls-readme"></a>

ソースプロバイダーに応じて、ページとイメージの基本 URLs を次の形式で構成します。
+ `{username}`: リポジトリがホストされているユーザー名。
+ `{repo}`: リポジトリ名。
+ `{ref}`: ソースリファレンス (ブランチ、タグ、コミット ID)。
+ `{path}`: リポジトリ内のページまたはイメージへのファイルパス。


| ソースプロバイダー | ページ URL | イメージ URL | 
| --- | --- | --- | 
| 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 | 

GitHub、GitLab、および は、パブリックリポジトリにリンクするページ URL とイメージ URLs の両方Bitbucketをサポートします。次の表は、プライベートリポジトリのイメージ URL とリンク URLs のレンダリングに対する各ソースプロバイダーのサポートを示しています。


| プライベートリポジトリのサポート | ソースプロバイダー | ページ URL | イメージ URL | 
| --- | --- | --- | --- | 
| GitHub | リポジトリにアクセスできる場合のみ | いいえ | 
| GitLab | リポジトリにアクセスできる場合のみ | いいえ | 
| Bitbucket | リポジトリにアクセスできる場合のみ | いいえ |