Lavorare con un file README

Carica un file README.md contenente istruzioni, diagrammi e informazioni essenziali per il tuo flusso di lavoro. Ogni versione del flusso di lavoro supporta un file README, che può essere aggiornato in qualsiasi momento.

I requisiti README includono:

• Il file README deve essere in formato markdown (.md)

• Dimensione massima del file: 500 KiB

Usa un README esistente

READMEs i file esportati dai repository Git contengono collegamenti relativi che in genere non funzionano al di fuori del repository. HealthOmics L'integrazione con Git li converte automaticamente in link assoluti per un corretto rendering nella console, eliminando la necessità di aggiornamenti manuali degli URL.

Per l' READMEs importazione da Amazon S3 o da unità locali, le immagini e i link devono essere pubblici URLs o avere i relativi percorsi aggiornati per un rendering corretto.

Nota

Le immagini devono essere ospitate pubblicamente per essere visualizzate nella HealthOmics console. Le immagini archiviate nei GitHub Enterprise Server nostri GitLab Self-Managed archivi non possono essere renderizzate.

Condizioni di rendering

La HealthOmics console interpola immagini e collegamenti accessibili al pubblico utilizzando percorsi assoluti. Per eseguire il rendering URLs da archivi privati, l'utente deve avere accesso al repository. I nostri GitHub Enterprise Server GitLab Self-Managed repository, che utilizzano domini personalizzati, HealthOmics non possono risolvere collegamenti relativi o eseguire il rendering di immagini archiviate in questi archivi privati.

La tabella seguente mostra gli elementi markdown supportati dalla visualizzazione README della AWS console.

Elemento	AWS console
Avvisi	Sì, ma senza icone
Distintivi	Sì
Formattazione di base del testo	Sì
Blocchi di codice	Sì, ma non dispone della funzionalità di evidenziazione della sintassi e del pulsante di copia
Sezioni pieghevoli	Sì
Titoli	Sì
Formati di immagine	Sì
Immagine (cliccabile)	Sì
Interruzioni di riga	Sì
Diagramma a sirena	Solo può aprire il grafico, spostare la posizione del grafico e copiare il codice
Citazioni	Sì
Pedice e apice	Sì
Tabelle	Sì, ma non supporta l'allineamento del testo
Allineamento del testo	Sì