AcademiaLight — Hugo Portfolio Template

SHA-256: 476ae6e29e9d80353d0b7eae9ecad3bf7409fe44bcb98ca25ef4b3fb61e5fe79

2026-10-13T01:52:13.921Z

# AcademiaLight

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/zdong1995/AcademiaLight?style=flat-square)](https://github.com/zdong1995/AcademiaLight/releases)
[![Hugo](https://img.shields.io/badge/Hugo-%5E0.62.0-ff4088?style=flat-square&logo=hugo)](https://gohugo.io/)
[![License](https://img.shields.io/github/license/zdong1995/AcademiaLight?style=flat-square)](https://github.com/zdong1995/AcademiaLight/blob/master/LICENSE)
[![Netlify Status](https://api.netlify.com/api/v1/badges/9e4fdc45-04a7-4a7c-90fd-07fe6195b1e3/deploy-status)](https://app.netlify.com/sites/academialight/deploys) ![GitHub last commit](https://img.shields.io/github/last-commit/zdong1995/AcademiaLight)

A clean, lightweight, and elegant Hugo theme for academic profiles. The UI design is inspired by [minimal-light](https://github.com/yaoyao-liu/minimal-light) theme.

[Demo](https://academialight.netlify.app) | [中文文档](README_zh.md)

## Prerequisites

Install Hugo:
```bash
# macOS (Homebrew)
brew install hugo

# Windows (Chocolatey)
choco install hugo-extended

# Linux (Snap)
snap install hugo
```

Verify installation:
```bash
hugo version
```

Make sure you have Hugo Extended version 0.80.0 or later.

## Quick Start

### Method 1: Using the Example Site

1. Clone the repository:
```bash
git clone https://github.com/zdong1995/AcademiaLight.git
```

2. Start Hugo server:
```bash
hugo server --source=exampleSite
```

Your site should now be available at `http://localhost:1313`

### Method 2: Using with Your Site

1. Create a new Hugo site (skip if you already have one):
```bash
hugo new site my-academic-site
cd my-academic-site
git init
```

2. Add the theme as a submodule:
```bash
git submodule add https://github.com/zdong1995/AcademiaLight.git themes/AcademiaLight
```

3. Configure in `config.yaml`:
```yaml
baseURL: "https://example.com"
theme: "AcademiaLight"
```

4. Start Hugo server:
```bash
hugo server
```

Your site should now be available at `http://localhost:1313`

## Configuration

### Basic Settings

```yaml
params:
  # Basic Information
  author: "Your Name"
  position: "Assistant Professor"
  affiliation: "Your University"
  email: "[email protected]"
  avatar: "/images/avatar.png"
  
  # Clustrmaps Configuration
  clustrmaps:
    enable: true
    widget_id: "YOUR_WIDGET_ID"
    
  # Social Links
  social:
    googleScholar: "https://scholar.google.com/citations?user=xxx"
    github: "https://github.com/username"
    linkedin: "https://linkedin.com/in/username"
```

### Content Structure

```
data/
├── about.yaml         # About information
├── publications.yaml  # Publications list
├── talks.yaml        # Talks and presentations
├── services.yaml     # Academic services
├── news.yaml         # News and updates
└── contacts.yaml     # Contact information
```

### Social Links

The theme supports various social media and academic profile links. Configure them in `config.yaml`:

```yaml
params:
  social:
    googleScholar: "https://scholar.google.com/citations?user=xxx"
    github: "https://github.com/username"
    linkedin: "https://linkedin.com/in/username"
    twitter: "https://twitter.com/username"
    x: "https://x.com/username"      # X (formerly Twitter)
    orcid: "https://orcid.org/xxxx-xxxx-xxxx-xxxx"
    researchgate: "https://www.researchgate.net/profile/username"
    blog: "https://example.com/blog"
    cv: "/files/cv.pdf"             # Local PDF file
```

Each social link can be enabled/disabled by adding or removing it from the configuration.

### Color Theme

Edit `assets/scss/_variables.scss`:

```scss
// Colors
$primary-color: #13294B;
$secondary-color: #39c;
$text-color: #595959;
```

### Layout Structure

The theme uses a modular SCSS structure:
- `_variables.scss`: Global variables
- `_base.scss`: Base styles
- `_layout.scss`: Layout structure
- `_components.scss`: Component styles
- `_sections.scss`: Section styles
- `_dark.scss`: Dark mode styles

## Contributing

Pull requests and issues are welcome!


## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details