Trabalhando com um arquivo README

Faça upload de 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 pode ser atualizado a qualquer momento.

Os requisitos do README incluem:

• O arquivo README deve estar no formato markdown (.md)

• Tamanho máximo do arquivo: 500 KiB

Use um README existente

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

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	Sim, mas não tem a funcionalidade de realce de sintaxe e botão de cópia
Seções dobráveis	Sim
Cabeçalhos	Sim
Formatos de imagem	Sim
Imagem (clicável)	Sim
Quebras de linha	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
Subscrito e sobrescrito	Sim
Tabelas	Sim, mas não suporta alinhamento de texto
Alinhamento de texto	Sim