Skip to content

kunheek/group.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Academic Group Website Template

Static website template for academic labs, research centers, and faculty groups.

License

MIT. See LICENSE.

Quick Start

cd group.github.io
python3 -m http.server 8000

Open http://localhost:8000.

Adoption Examples

Example Page Deployment

This repository can publish a live example page for the template under:

To use it for the example page:

  1. Push this repository to GitHub.
  2. Open Settings > Pages.
  3. Set Source to Deploy from a branch.
  4. Select the main branch and the / (root) folder.
  5. Save and wait for GitHub Pages to finish deploying.

Notes:

  • The site uses relative paths, so it works when hosted under the /group.github.io/ subpath.
  • .nojekyll is included so GitHub Pages serves the repository as a plain static site.
  • The web manifest start_url and scope are configured for subdirectory deployment.

Instructions For Adopters

Adopters should treat the live example page above as a demo of the template, not as the default publishing target for their own site.

Recommended adoption flow:

  1. Click Use this template or fork the repository into your own GitHub account or organization.
  2. Rename the repository to match your preferred public URL.
  3. Replace the sample branding, people, publications, projects, gallery items, and contact information.
  4. Decide how you want to publish:
    • Project site: https://<username>.github.io/<repo-name>/
    • User or org site: https://<username>.github.io/
    • Custom domain: point your domain to GitHub Pages and add the domain configuration you need
  5. In your repository, open Settings > Pages and choose Deploy from a branch, then publish the branch and folder you want to serve.

Adopters will usually want to make these changes before publishing:

  • Replace the example adoption links in index.html and README.md
  • Update the footer copyright and contact details
  • Rename the site title and logo assets
  • Review assets/logos/site.webmanifest if you want different install metadata

What To Customize

  1. Update group identity in index.html and pages/*.html.
  2. Replace sample data in data/people.json, data/publications.json, data/projects.json, data/news.json, data/gallery.json, and data/patents.json.
  3. Swap placeholder assets in assets/logos/ and assets/images/.
  4. Rewrite pages/apply.html to match your actual recruiting or admissions workflow.

Project Structure

├── index.html
├── pages/
│   ├── people.html
│   ├── publications.html
│   ├── patents.html
│   ├── projects.html
│   ├── gallery.html
│   └── apply.html
├── data/
│   ├── people.json
│   ├── publications.json
│   ├── patents.json
│   ├── projects.json
│   ├── gallery.json
│   └── news.json
├── assets/
│   ├── logos/
│   └── images/
├── js/
└── css/

Data Files

data/people.json

  • faculty: principal investigators or faculty members.
  • current: current group members.
  • alumni: former members and next positions.

data/publications.json

  • categories: labels used by the publication filters.
  • publications: paper entries with authors, venue, year, type, and optional links.

data/projects.json

  • projects: active, planned, or completed projects.
  • image: filename in assets/images/projects/ or a full URL.

data/gallery.json

  • gallery_items: events, travel, retreats, demos, and other media.
  • image: filename in assets/images/gallery/ or a full URL.

data/news.json

  • news: homepage updates shown in reverse chronological order.

data/patents.json

  • patents: granted patents or applications grouped by region.

Notes

  • The repository now uses neutral placeholder content so it can be published as a public template.
  • The pages are static and require no build step.
  • JSON fetches assume the site is served over HTTP, so use a local server instead of opening files directly.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors