Trabajar con un archivo README

Cargue un archivo README.md que contenga instrucciones, diagramas e información esencial para su flujo de trabajo. Cada versión del flujo de trabajo admite un archivo README, que se puede actualizar en cualquier momento.

Los requisitos de README incluyen:

• El archivo README debe estar en formato markdown (.md)

• Tamaño máximo de archivo: 500 KiB

Utilice un archivo README existente

READMEs los archivos exportados desde los repositorios de Git contienen enlaces relativos que normalmente no funcionan fuera del repositorio. HealthOmics La integración de Git los convierte automáticamente en enlaces absolutos para una representación adecuada en la consola, lo que elimina la necesidad de actualizar manualmente las URL.

En el caso de las READMEs importaciones desde Amazon S3 o unidades locales, las imágenes y los enlaces deben ser públicas URLs o tener sus rutas relativas actualizadas para una representación adecuada.

nota

Las imágenes deben estar alojadas públicamente para poder mostrarse en la HealthOmics consola. Las imágenes almacenadas en GitHub Enterprise Server GitLab Self-Managed los repositorios no se pueden renderizar.

Condiciones de renderizado

La HealthOmics consola interpola imágenes y enlaces de acceso público mediante rutas absolutas. Para renderizar URLs desde repositorios privados, el usuario debe tener acceso al repositorio. Nuestros GitHub Enterprise Server GitLab Self-Managed repositorios, que utilizan dominios personalizados, HealthOmics no pueden resolver los enlaces relativos ni renderizar las imágenes almacenadas en estos repositorios privados.

En la siguiente tabla se muestran los elementos de marcado compatibles con la vista README de la AWS consola.

Elemento	AWS consola
Alertas	Sí, pero sin iconos
Insignias	Sí
Formato de texto básico	Sí
Bloques de código	Sí, pero no tiene la funcionalidad de resaltar la sintaxis ni de copiar
Secciones plegables	Sí
Encabezados	Sí
Formatos de imagen	Sí
Imagen (en la que se puede hacer clic)	Sí
Saltos de línea	Sí
Diagrama de sirena	Solo puede abrir un gráfico, mover la posición del gráfico y copiar código
Cuotas	Sí
Subíndice y superíndice	Sí
Tablas	Sí, pero no admite la alineación del texto
Alineación de texto	Sí