vios.science Website

This project is built using Astro and contains the website source code for vios.science.

🚀 Getting Started

To run the project locally, run the following commands in the terminal from the root of the project:

# 1. Install dependencies
npm install

# 2. Start the local development server
npm run dev

Your site will be running at http://localhost:4321.

Build & Preview

To test a production build before deploying:

npm run build
npm run preview

📝 How to Maintain Content

The site uses Astro Content Collections plus data files to keep content maintainable.

👥 Team Members (src/content/team/)

To add or update a team member, create/edit a .md file in the src/content/team/ directory.

Example frontmatter:

---
title: "First Last"
role: "none" # or another role
subtitle: "PhD Student"
profile: "filename.jpg" # image stored in public/assets/
github: "https://github.com/username"
linkedin: "https://linkedin.com/in/username"
collection: team
permalink: /team/first
---
Biographical text goes here...

🗞️ News (src/content/news/)

Add Markdown files for news updates. Include title and date in the frontmatter.

📚 Publications (src/data/publications.yaml)

Publications are stored as a YAML list in src/data/publications.yaml.

This file is generated from the separate Publication Lists repository using OpenAlex data, then synced into this website repo via automation.

The cross-repo workflow:

• runs manually or on schedule (on the 1st and 16th of each month),
• updates src/data/publications.yaml in this repo via a PR on branch publications-update,
• preserves existing extra fields (for example image, code, pdf).

Each item supports:

- title: Paper Title
  authors: Author A, Author B
  venue: Conference/Journal Name
  date: 'YYYY-MM-DD'
  image: /assets/images/publications/example.png # optional
  pdf: /assets/pdfs/example.pdf                  # optional
  code: https://github.com/org/repo              # optional
  website: https://doi.org/...                   # optional

💻 Tutorials (src/content/tutorials/)

Add Markdown files for tutorials. Useful frontmatter properties: title, description, date, author.

📄 Static Pages (src/content/pages/)

Markdown and MDX content for standalone pages. E.g., alumni.mdx. Uses title in frontmatter.

🔬 Projects (src/data/projects.json)

The projects (both ongoing and completed) are listed in src/data/projects.json. Edit this JSON file to add new projects.

{
    "title": "Project Title",
    "funder": "Funder Name",
    "short_funder": "Short Funder Name",
    "team": "Team structure",
    "timeline": "MM/YY - MM/YY",
    "url": "Project link"
}

🖼️ Adding Assets and Images

Static assets such as images and PDFs should be placed inside the public/ directory (e.g., in public/assets/). Anything in public/ is served at the root URL (for example, public/assets/image.jpg is accessible at /assets/image.jpg).

🛠 Project Structure

/
├── public/                 # Static assets (images, icons)
├── src/
│   ├── content/            # Markdown data collections (team, news, etc.)
│   ├── data/               # Data files (projects.json, publications.yaml)
│   ├── layouts/            # Page layouts
│   ├── utils/              # Helper utilities
│   └── pages/              # Astro routing (.astro pages)
├── astro.config.mjs        # Astro configuration
└── package.json            # Dependencies and scripts