Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 2.27 KB

README.md

File metadata and controls

36 lines (28 loc) · 2.27 KB

BioInfoCommunity.github.io

Building the site

The site is built with Eleventy and deployed to GitHub Pages by .github/workflows/pages.yml.

npm install
npm run build   # fetches repo data (needs GITHUB_TOKEN for higher rate limits) and writes _site/
npm run serve   # local preview with live reload
  • spaces.json: which repos belong to which space, their translation branches and status.
  • scripts/build-repos.mjs: writes data/repos.json from the GitHub API (generated, not committed).
  • scripts/build-contributors.mjs: writes data/contributors.json, the contributors of the org's public repos merged across repos, shown at /contributors/ (generated, not committed). Bots and forks are left out.
  • contributors.yaml: people added by hand, shown under "Other contributors" on /contributors/ (for work the repos don't show). Each entry has a name and an optional github username.
  • src/: pages and templates. src/spaces/ generates the space list and one page per space.
  • src/index.njk: the homepage.

Adding highlights

Each highlight is one YAML file in highlights/, named by its date (for example highlights/2026-10-21.yaml):

title: Portuguese translation of AlphaFold
description: Short summary, under 150 words.
url: https://example.org/post        # optional, https only
community: alphafold                 # optional, a space id from spaces.json; omit for general highlights
date: 2026-10-21                     # used for ordering and the date shown on the item
date_archive: 2026-12-21             # optional, the item stops showing on this date
status: live                         # live or draft; only live items are shown
  • scripts/build-highlights.mjs validates the files and writes data/highlights.json (generated, not committed). Invalid items fail the build.
  • A live highlight shows as soon as its file is in highlights/, whatever its date, until date_archive is reached. The site rebuilds daily, so changes appear on the next build.
  • Highlights are ordered by how close their date is to today, past or future. The homepage shows the first three, and each space page shows its items in the same order. Items without a community appear on the homepage and the all-highlights page, but not on space pages.