galaxyproject Galaxy Hub News Posts
Create news posts for the Galaxy Project website (galaxyproject.org).
Directory Structure
Posts live in /content/news/YYYY-MM-DD-slug-name/:
content/news/2025-01-15-my-announcement/
├── index.md # Main content file
├── hero.png # Images in same directory
└── images/ # OR in images/ subdirectory
└── figure1.png
Required Frontmatter
---
title: "Post Title"
date: "YYYY-MM-DD"
tease: "Short description for listing pages"
tags: [galaxy, training, tools]
subsites: [all]
contributions:
authorship:
- contributor-id # GitHub username or ID from hub contributors
---
Note: The contributions block replaces the old authors field. Contributor IDs (not free-text names) are used — these must match entries known to the hub. You can also add optional funding entries (e.g. funding: [deNBI]) under contributions.
Tags
IMPORTANT: All tags must exist in content/TAGS.yaml. CI validation (scripts/validate_news.py) will reject unknown tags. Before using a tag, check the file to confirm it's in the allow-list. Tags are case-sensitive.
Optional Frontmatter Fields
| Field | Description |
|---|---|
main_subsite |
Primary subsite (eu, freiburg, global) |
supporters |
Funding/support logos [elixir, denbi, eosc] |
location.name |
Event location |
hide_tease |
Set false to show tease on listing |
autotoc |
Enable/disable table of contents |
Image Handling
Option A - Same directory (simpler):
Option B - images/ subdirectory (for many images):
<img src="./images/figure1.png" />
CRITICAL: HTML img tags MUST use ./ prefix:
<img src="./images/x.png">✓<img src="images/x.png">❌ (build fails!)
Vega Charts
Use external URLs only (gists work well):
<vega-embed spec="https://gist.githubusercontent.com/user/id/raw/hash/chart.json" />
Create gist: gh gist create chart.json --public
Local file paths do NOT work with vega-embed.
Styled HTML Tables
<table class="table">
<tr>
<td style="background: linear-gradient(135deg, #667eea, #764ba2); color: white; padding: 15px;">
<strong>Value</strong><br/>label
</td>
</tr>
</table>
Supported styles:
background-color: #xxxbackground: linear-gradient(...)color,padding,border-radius- Emojis work (flags: 🇪🇺 🇺🇸 🇦🇺)
Workflow
- Create feature branch:
git checkout -b news/post-slug - Create directory:
mkdir -p content/news/YYYY-MM-DD-slug-name - Add index.md with frontmatter
- Verify all tags exist in
content/TAGS.yaml - Add images (resize large ones first)
- For Vega charts: create gist, use raw URL
- Test locally:
yarn develop - Commit, push, and open a PR against
galaxyproject/galaxy-hub
Common Issues
| Problem | Solution |
|---|---|
| Build fails on images | Use ./ prefix in HTML img src |
| Vega chart blank | Must use external URL (gist), not local file |
| Large images slow build | Resize with PIL before committing |
| CI fails on unknown tags | All tags must exist in content/TAGS.yaml — check before using |
References
- See
references/formatting.mdfor detailed formatting guide - See
examples/sample-post.mdfor complete template