Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Utilisation d'un fichier README
Téléchargez un fichier README.md contenant des instructions, des diagrammes et des informations essentielles pour votre flux de travail. Chaque version du flux de travail prend en charge un fichier README, qui peut être mis à jour à tout moment.
Les exigences du README incluent :
-
Le fichier README doit être au format Markdown (.md)
-
Taille de fichier maximale : 500 KiB
Utiliser un fichier README existant
READMEs exportés depuis les référentiels Git contiennent des liens relatifs qui ne fonctionnent généralement pas en dehors du référentiel. HealthOmics L'intégration Git les convertit automatiquement en liens absolus pour un rendu correct dans la console, éliminant ainsi le besoin de mises à jour manuelles des URL.
Pour les images READMEs importées depuis Amazon S3 ou des lecteurs locaux, les images et les liens doivent être soit publics, URLs soit avoir leurs chemins relatifs mis à jour pour un rendu correct.
Note
Les images doivent être hébergées publiquement pour être affichées dans la HealthOmics console. Les images stockées dans GitHub Enterprise Server ou dans GitLab Self-Managed des référentiels ne peuvent pas être rendues.
Conditions de rendu
La HealthOmics console interpole les images et les liens accessibles au public à l'aide de chemins absolus. Pour effectuer un rendu à URLs partir de référentiels privés, l'utilisateur doit avoir accès au référentiel. GitLab Self-ManagedLes référentiels For GitHub Enterprise Server ou, qui utilisent des domaines personnalisés, HealthOmics ne peuvent pas résoudre les liens relatifs ni afficher les images stockées dans ces référentiels privés.
Le tableau suivant indique les éléments Markdown pris en charge par la vue README de la AWS console.
| Element | AWS console |
|---|---|
| Alerts (Alertes) | Oui, mais sans icônes |
| Badges | Oui |
| Formatage de texte de base | Oui |
| Blocs de code |
Oui, mais ne possède pas de fonctionnalité de surlignage syntaxique |
| Sections pliables | Oui |
| Rubriques |
Oui |
| Formats d'image |
Oui |
| Image (cliquable) |
Oui |
| Sauts de ligne |
Oui |
| Schéma de la sirène | Peut uniquement ouvrir le graphique, déplacer la position du graphique et copier le code |
| Citations | Oui |
| Indice |
Oui |
| Tables |
Oui, mais ne prend pas en charge l'alignement du texte |
| Alignement du texte | Oui |
