Working with a README file
Upload a README.md file containing instructions, diagrams, and essential information for your workflow. Each workflow version supports one README file, which can be updated anytime.
README requirements include:
-
README file must be in markdown (.md) format
-
Maximum file size: 500 KiB
Use an existing README
READMEs exported from Git repositories contain relative links that typically do not work outside the repository. HealthOmics Git integration automatically converts these to absolute links for proper rendering in the console, eliminating the need for manual URL updates.
For READMEs imported from Amazon S3 or local drives, images and links must either use public URLs or have their relative paths updated for proper rendering.
Note
Images must be publicly hosted to display in the HealthOmics console. Images stored in GitHub Enterprise Server or GitLab Self-Managed repositories cannot be rendered.
Rendering conditions
The HealthOmics console interpolates publicly accessible images and links using absolute paths. To render URLs from private repositories, the user must have access to the repository. For GitHub Enterprise Server or GitLab Self-Managed repositories, which use custom domains, HealthOmics cannot resolve relative links or render images stored in these private repositories.
The following table shows the markdown elements that are supported by the AWS console README view.
| Element | AWS console |
|---|---|
| Alerts | Yes, but without icons |
| Badges | Yes |
| Basic text formatting | Yes |
| Code blocks |
Yes, but does not have syntax highlight |
| Collapsible sections | Yes |
| Headings |
Yes |
| Image formats |
Yes |
| Image (clickable) |
Yes |
| Line breaks |
Yes |
| Mermaid diagram | Only can open graph, move graph position, and copy code |
| Quotes | Yes |
| Subscript |
Yes |
| Tables |
Yes, but does not support text alignment |
| Text alignment | Yes |
