Mit einer README-Datei arbeiten

Laden Sie eine README.md-Datei hoch, die Anweisungen, Diagramme und wichtige Informationen für Ihren Arbeitsablauf enthält. Jede Workflow-Version unterstützt eine README-Datei, die jederzeit aktualisiert werden kann.

Zu den README-Anforderungen gehören:

• Die README-Datei muss im Markdown-Format (.md) vorliegen

• Maximale Dateigröße: 500 KiB

Verwenden Sie eine vorhandene README-Datei

READMEs Aus Git-Repositorys exportierte Dateien enthalten relative Links, die normalerweise außerhalb des Repositorys nicht funktionieren. HealthOmics Die Git-Integration konvertiert diese automatisch in absolute Links für das korrekte Rendern in der Konsole, sodass keine manuellen URL-Updates erforderlich sind.

Bei READMEs Importen aus Amazon S3 oder lokalen Laufwerken müssen Bilder und Links entweder öffentlich verwendet werden URLs oder ihre relativen Pfade müssen aktualisiert werden, damit sie korrekt gerendert werden.

Anmerkung

Bilder müssen öffentlich gehostet werden, damit sie in der HealthOmics Konsole angezeigt werden können. Bilder, die in GitHub Enterprise Server oder GitLab Self-Managed Repositorys gespeichert sind, können nicht gerendert werden.

Bedingungen für das Rendern

Die HealthOmics Konsole interpoliert öffentlich zugängliche Bilder und Links mithilfe absoluter Pfade. Um URLs aus privaten Repositorys rendern zu können, muss der Benutzer Zugriff auf das Repository haben. Für GitHub Enterprise Server oder GitLab Self-Managed Repositorys, die benutzerdefinierte Domänen verwenden, können relative Links HealthOmics nicht aufgelöst oder Bilder gerendert werden, die in diesen privaten Repositorys gespeichert sind.

Die folgende Tabelle zeigt die Markdown-Elemente, die von der README-Ansicht der AWS Konsole unterstützt werden.

Element	AWS Konsole
Benachrichtigungen	Ja, aber ohne Icons
Abzeichen	Ja
Grundlegende Textformatierung	Ja
Codeblöcke	Ja, hat aber keine Syntaxhervorhebungs - und Kopierschaltflächenfunktionen
Zusammenklappbare Abschnitte	Ja
Überschriften	Ja
Bildformate	Ja
Bild (anklickbar)	Ja
Zeilenumbrüche	Ja
Meerjungfrau-Diagramm	Kann nur das Diagramm öffnen, die Position des Diagramms verschieben und Code kopieren
Zitate	Ja
Tiefgestellt und hochgestellt	Ja
Tabellen	Ja, unterstützt aber keine Textausrichtung
Textausrichtung	Ja

Bild und Link werden verwendet URLs

Strukturieren Sie je nach Quellenanbieter Ihre Basis URLs für Seiten und Bilder in den folgenden Formaten.

• {username}: Der Benutzername, unter dem das Repository gehostet wird.

• {repo}: Der Name des Repositorys.

• {ref}: Die Quellreferenz (Branch, Tag und Commit-ID).

• {path}: Der Dateipfad zur Seite oder zum Bild im Repository.

Quellanbieter	Seiten-URL	Bild-URL
GitHub	https://github.com/{username}/{repo}/blob/{ref}/{path}	https://github.com/{username}/{repo}/blob/{ref}/{path}?raw=true https://raw.githubusercontent.com/{username}/{repo}/{ref}/{path}
GitLab	https://gitlab.com/{username}/{repo}/-/blob/{ref}/{path}	https://gitlab.com/{username}/{repo}/-/raw/{ref}/{path}
Bitbucket	https://bitbucket.org/{username}/{repo}/src/{ref}/{path}	https://bitbucket.org/{username}/{repo}/raw/{ref}/{path}

GitHubGitLab, und Bitbucket unterstützt sowohl Seiten als auch Bilder URLs , die auf ein öffentliches Repository verweisen. Die folgende Tabelle zeigt, wie die einzelnen Quellenanbieter das Rendern von Bildern und Links URLs für private Repositorys unterstützen.

Unterstützung für private Repositorys
Quellenanbieter	Seiten-URL	Bild-URL
GitHub	Nur mit Zugriff auf das Repository	Nein
GitLab	Nur mit Zugriff auf das Repository	Nein
Bitbucket	Nur mit Zugriff auf das Repository	Nein