Skip to content

3BioCompBio/3BIO-Bioinfo

Repository files navigation

3BIO-BioInfo Laboratory Website

Modern, easy-to-maintain website built with Hugo static site generator.

Quick Start

Prerequisites

  • Hugo (v0.100.0 or higher) installed on your system
  • Git (for version control and GitHub Pages deployment)

Running the Site Locally

# Navigate to the project directory
cd /path/to/3BIO-Bioinfo

# Start the Hugo development server
hugo server -D

# Open your browser to http://localhost:1313

Building for Production

# Build the static site
hugo

# The generated site will be in the 'public/' directory
# Upload the contents of 'public/' to your web server

Easy Maintenance Guide

This website is designed to be extremely easy to maintain. All common updates can be done by editing simple YAML files - no coding required!

Adding or Updating Team Members

File to edit: data/team.yaml

  1. Open data/team.yaml in any text editor
  2. Find the appropriate section (professors, postdocs, phd_students, or staff)
  3. To add a new member, copy this template:
- name: "Full Name"
  role: "Job Title"
  email: "email@ulb.be"
  phone: "+32 (0)2 650 XX XX"
  office: "S.UD3.XXX"
  bio: "Brief biography (optional)"
  research_interests: []
  website: ""
  1. Fill in the details
  2. Save the file
  3. The website will automatically update when you rebuild

To remove a team member: Simply delete their entire block from the file.

To update information: Just change the relevant fields and save.

Adding Publications

File to edit: data/publications.yaml

  1. Open data/publications.yaml
  2. Add a new publication using this template:
- key: "firstauthorYEARkeyword"        # unique identifier, used for citations
  title: "Your Publication Title"
  authors: "Author1 F, Author2 J, Author3 M"
  year: 2025
  venue: "Journal Name"
  volume: "Volume(Issue)"
  pages: "Page numbers"
  doi: "10.xxxx/xxxxx"
  pdf: ""
  abstract: "Brief description of the publication"
  1. Publications are automatically sorted by year (newest first)
  2. Save and rebuild

Tip: The key field is used to cite the publication anywhere on the site (see Citing a Publication below).

Adding Posters

File to edit: data/posters.yaml

  1. Open data/posters.yaml
  2. Add a new entry:
- key: "firstauthorYEARevent"          # unique identifier, used to reference the poster
  title: "Poster Title"
  authors: "Author1 F, Author2 J"
  year: 2025
  event: "Conference Name 2025"
  pdf: "/posters/firstauthorYEARevent.pdf"
  1. Place the PDF file in static/posters/ (e.g. static/posters/firstauthorYEARevent.pdf)
  2. Save and rebuild

Citing a Publication or Poster

You can reference a publication, poster, or any PDF anywhere on the site — in team member bios or in any page written in Markdown. A citation appears as a clickable inline link; hovering shows a tooltip with the full reference, and clicking a poster/PDF link opens the document in a modal.

Syntax reference

Syntax Where YAML required Result
[[cite:doe2024folding]] bio, Markdown publications.yaml [Doe et al., 2024] with tooltip
[[cite:doe2024folding:Mon libellé]] bio, Markdown publications.yaml Mon libellé with tooltip
[[poster:doe2024ismb]] bio, Markdown posters.yaml [poster: <titre>], ouvre PDF
[[poster:doe2024ismb:Mon libellé]] bio, Markdown posters.yaml Mon libellé, ouvre PDF
[[pdf:/offres/job2026.pdf:Voir l'offre]] bio, Markdown Voir l'offre, ouvre PDF

[[pdf:...]] permet de lier directement un fichier PDF (ex. offre d'emploi) sans passer par un fichier YAML. Placez le PDF dans static/ et utilisez le chemin absolu depuis la racine du site.

In a team member bio (data/team.yaml)

Use the inline syntax directly in the bio field:

- name: "Jane Doe"
  bio: "Her work on protein folding [[cite:doe2024folding]] was presented [[poster:doe2024ismb:voir le poster]] at ISMB."

In a Markdown page

Use the corresponding shortcodes:

We showed {{< cite key="doe2024folding" >}} that...

The poster {{< poster key="doe2024ismb" >}} presented at ISMB...

Adding Software Tools

File to edit: data/software.yaml

  1. Open data/software.yaml
  2. Add a new tool:
- name: "Tool Name"
  description: "What the tool does"
  url: "https://github.com/username/tool"
  documentation: "https://docs.example.com"
  publication_doi: "10.xxxx/xxxxx"
  1. Save and rebuild

Adding Research Projects

Directory: content/research/

  1. Create a new file: content/research/project-name.md
  2. Use this template:
---
title: "Project Title"
date: 2024-01-01
---

Description of the research project goes here. You can use regular text,
**bold**, *italic*, bullet points, etc.
  1. Save the file
  2. The project will automatically appear on the Research page

Adding News/Blog Posts

Directory: content/news/

  1. Create a new file: content/news/2025-01-15-news-title.md
  2. Use this template:
---
title: "News Title"
date: 2025-01-15
---

Your news content here...
  1. The 3 most recent news items appear on the homepage

Updating Site Configuration

File: hugo.toml

Update site-wide settings like:

  • Site title
  • Contact information
  • Menu items
  • Social media links

File Structure

3BIO-Bioinfo/
├── hugo.toml              # Main configuration file
├── content/               # Page content
│   ├── _index.md         # Homepage content
│   ├── team.md           # Team page
│   ├── publications.md   # Publications page
│   ├── research/         # Research project pages
│   ├── software.md       # Software page
│   ├── opportunities.md  # Opportunities page
│   ├── teaching.md       # Teaching page
│   └── news/             # News/blog posts
├── data/                  # Data files (EASY TO EDIT!)
│   ├── team.yaml         # Team members data
│   ├── publications.yaml # Publications data
│   ├── posters.yaml      # Posters data
│   └── software.yaml     # Software tools data
├── static/
│   └── posters/          # Poster PDF files
├── themes/
│   └── bioinfo-clean/    # Custom theme
└── public/               # Generated site (after running 'hugo')

Common Tasks

Task 1: Add a New PhD Student

  1. Open data/team.yaml
  2. Scroll to the phd_students: section
  3. Add:
- name: "New Student Name"
  role: "PhD Student"
  email: "student@ulb.be"
  phone: ""
  office: "S.UD3.XXX"
  bio: ""
  research_interests: []
  website: ""
  1. Save and run hugo server to preview

Task 2: Update Someone's Contact Info

  1. Open data/team.yaml
  2. Find the person's entry
  3. Update their email, phone, or office field
  4. Save

Task 3: Add This Year's Publications

  1. Open data/publications.yaml
  2. Add all new publications with year: 2025 and a unique key
  3. They'll automatically appear under a "2025" heading
  4. You can then cite them anywhere with [[cite:key]] (in yaml) or {{< cite key="…" >}} (in Markdown)
  5. Save

Task 4: Change Homepage Text

  1. Open content/_index.md
  2. Edit the text below the --- markers
  3. Save

Styling and Design

The site uses a clean, minimal design with:

  • Responsive layout (works on mobile, tablet, desktop)
  • Professional color scheme
  • Easy-to-read typography
  • Organized layouts for different content types

To modify colors, fonts, or layouts, edit:

  • CSS: themes/bioinfo-clean/static/css/style.css
  • HTML templates: themes/bioinfo-clean/layouts/

Deployment

Option 1: GitHub Pages (Recommended - Automatic!)

Automatic deployment on every push to master!

See GITHUB_PAGES_DEPLOYMENT.md for complete setup instructions.

Quick setup:

git init
git add .
git commit -m "Initial commit"
git branch -M master
git remote add origin https://github.com/YOUR-USERNAME/REPO-NAME.git
git push -u origin master

Enable GitHub Pages in your repository settings → Pages → Source: GitHub Actions

Your site will be live at: https://YOUR-USERNAME.github.io/REPO-NAME/

Every time you push to master, GitHub Actions automatically rebuilds and deploys your site!

Option 2: Manual FTP/SFTP Upload

  1. Run hugo to build the site
  2. Upload the entire public/ directory to your web server
  3. Done!

Option 3: Other Platforms

Works with: Netlify, Vercel, CloudFlare Pages, AWS S3, etc.

Support

For Hugo documentation: https://gohugo.io/documentation/

For questions about this specific site, contact the system administrator.

Tips

  • Always test locally with hugo server before deploying
  • Keep backups of your data/ directory
  • Use descriptive file names for content
  • Check that all links work after making changes
  • The site builds in seconds, so iterate quickly!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors