As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# HealthOmics Arquivos README do fluxo de trabalho
<a name="workflows-readme"></a>

Você pode carregar um arquivo README.md contendo instruções, diagramas e informações essenciais para seu fluxo de trabalho. Cada versão do fluxo de trabalho oferece suporte a um arquivo README, que você pode atualizar a qualquer momento.

**Os requisitos do README incluem:**
+ O arquivo README deve estar no formato markdown (.md)
+ Tamanho máximo do arquivo: 500 KiB

**Topics**
+ [Use um README existente](#workflows-add-readme)
+ [Condições de renderização](#workflows-rendering-readme)

## Use um README existente
<a name="workflows-add-readme"></a>

READMEs exportados dos repositórios Git contêm links relativos que normalmente não funcionam fora do repositório. HealthOmics A integração com o Git os converte automaticamente em links absolutos para uma renderização adequada no console, eliminando a necessidade de atualizações manuais de URL. 

Para READMEs importados do Amazon S3 ou de unidades locais, as imagens e os links devem ser públicos URLs ou ter seus caminhos relativos atualizados para uma renderização adequada.

**nota**  
As imagens devem ser hospedadas publicamente para serem exibidas no HealthOmics console. Imagens armazenadas em repositórios GitHub Enterprise Server ou GitLab Self-Managed repositórios não podem ser renderizadas.

## Condições de renderização
<a name="workflows-rendering-readme"></a>

O HealthOmics console interpola imagens e links acessíveis ao público usando caminhos absolutos. Para renderizar URLs a partir de repositórios privados, o usuário deve ter acesso ao repositório. GitLab Self-ManagedOs repositórios for GitHub Enterprise Server or, que usam domínios personalizados, HealthOmics não conseguem resolver links relativos nem renderizar imagens armazenadas nesses repositórios privados.

A tabela a seguir mostra os elementos de marcação que são compatíveis com a visualização README do AWS console.


| Elemento | AWS console | 
| --- | --- | 
| Alertas | Sim, mas sem ícones | 
| Distintivos | Sim | 
| Formatação básica de texto | Sim | 
| [Blocos de código](https://www.markdownguide.org/basic-syntax/#code-blocks) | Sim, mas não tem a funcionalidade de [realce de sintaxe](https://www.markdownguide.org/extended-syntax/#syntax-highlighting) e botão de cópia  | 
| Seções dobráveis | Sim | 
| [Cabeçalhos](https://www.markdownguide.org/basic-syntax/#headings) | Sim | 
| [Formatos de imagem](https://www.markdownguide.org/basic-syntax/#images-1) | Sim | 
| [Imagem (clicável)](https://www.markdownguide.org/basic-syntax/#linking-images) | Sim | 
| [Quebras de linha](https://www.markdownguide.org/basic-syntax/#line-breaks) | Sim | 
| Diagrama de sereia | Só pode abrir o gráfico, mover a posição do gráfico e copiar o código | 
| Cotações | Sim | 
| [https://www.markdownguide.org/extended-syntax/#subscript](https://www.markdownguide.org/extended-syntax/#subscript) | Sim | 
| [Tabelas](https://www.markdownguide.org/extended-syntax/#tables) | Sim, mas não suporta alinhamento de texto | 
| Alinhamento de texto | Sim | 

### Usando imagem e link URLs
<a name="workflows-urls-readme"></a>

Dependendo do seu provedor de origem, estruture sua base URLs para páginas e imagens nos seguintes formatos.
+ `{username}`: o nome de usuário em que o repositório está hospedado.
+ `{repo}`: O nome do repositório.
+ `{ref}`: a referência da fonte (ramificação, tag e ID do commit). 
+ `{path}`: o caminho do arquivo para a página ou imagem no repositório. 


| Provedor de origem | URL da página | URL da imagem | 
| --- | --- | --- | 
| 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, e Bitbucket suportam páginas e imagens URLs vinculadas a um repositório público. A tabela a seguir mostra o suporte de cada provedor de origem para renderizar imagens e links URLs para repositórios privados.


| Suporte a repositórios privados | Provedor de origem | URL da página | URL da imagem | 
| --- | --- | --- | --- | 
| GitHub | Somente com acesso ao repositório | Não | 
| GitLab | Somente com acesso ao repositório | Não | 
| Bitbucket | Somente com acesso ao repositório | Não |