A Modern, Responsive and Customizable Academic Personal Homepage Template

🌐 View Live Demo

ScholarPages is an enhanced academic homepage template with beautiful styling and powerful customization options:

• 🎨 Customizable Theme Colors: Easily customize link hover colors, heading colors, and code highlight styles
• 🔄 Automatic Google Scholar Updates: Automatically update your citations using Google Scholar crawler and GitHub Actions
• 📊 Google Analytics Support: Track your homepage traffic with simple configuration
• 📱 Fully Responsive: Automatically adjusts for different screen sizes and viewports
• 🎯 Clean & Modern Design: Beautiful and simple design perfect for academic personal homepages
• 🔍 SEO Optimized: Search Engine Optimization helps search engines find and rank your content
• 🌐 Configurable Footer: Support for ICP filing number and custom footer text

ScholarPages comes with enhanced styling that you can easily customize:

• Link Hover Effect: Smooth color transition with customizable hover color (default: orange #f09228)
• Heading Colors: Custom colors for h1 and h2 headings (default: blue rgb(82, 123, 189))
• Code Highlight: Custom background and text colors for inline code (default: deep blue #03228d)

• Optional ICP filing number (for Chinese websites)
• Custom footer text
• Clean and compact design

Edit _sass/_variables.scss to change theme colors:

/* theme colors - customizable */
$theme-link-hover-color     : #f09228;           // link hover color
$theme-heading-color        : rgb(82, 123, 189); // heading color
$theme-code-highlight-bg    : #03228d;           // code background
$theme-code-highlight-text  : #fff;              // code text color

Configure footer in _config.yml:

footer:
  icp_number       : "your-icp-number"  # optional, for Chinese websites
  custom_text      : "your custom text" # optional

For detailed customization guide, see docs/THEME_CUSTOMIZATION.md.

Fork this repository and rename it to USERNAME.github.io, where USERNAME is your GitHub username.

1. Find your Google Scholar ID from your Google Scholar profile URL
   • Example: https://scholar.google.com/citations?user=SCHOLAR_ID
   • SCHOLAR_ID is your Google Scholar ID
2. Add the Google Scholar ID as a repository secret:
   • Go to Settings -> Secrets -> Actions -> New repository secret
   • Set name=GOOGLE_SCHOLAR_ID and value=SCHOLAR_ID
3. Enable GitHub Actions:
   • Go to Actions tab
   • Click "I understand my workflows, go ahead and enable them"
   • This action will generate gs_data.json in the google-scholar-stats branch
   • The action runs automatically when you update the main branch and daily at 08:00 UTC

1. Use favicon-generator to generate favicon files
2. Download all generated files to images/ directory

Edit _config.yml to customize your homepage:

# Site Settings
title                    : "Your Name"
description              : "Your description here"
repository               : "USERNAME/USERNAME.github.io"
google_scholar_stats_use_cdn : true

# Google Analytics (optional)
google_analytics_id      : ""

# SEO Related (optional)
google_site_verification : ""
bing_site_verification   : ""
baidu_site_verification  : ""

# Site Author
author:
  name             : "Your Name"
  avatar           : "images/profile.png"
  bio              : "Your University"
  location         : "City, Country"
  employer         : ""
  googlescholar    : "https://scholar.google.com/citations?user=YOUR_ID"
  email            : "your.email@example.com"
  github           : "your-github-username"
  linkedin         : "your-linkedin-username"
  # ... more social links

# Footer Configuration
footer:
  icp_number       : ""  # for Chinese websites
  custom_text      : ""  # optional custom footer text

Edit _pages/about.md to add your homepage content:

• You can use HTML + Markdown syntax
• Use <span class='show_paper_citations' data='PAPER_ID'></span> to display paper citations
  • Get PAPER_ID from Google Scholar: click on a paper and find citation_for_view=XXXX

Your homepage will be published at https://USERNAME.github.io

Install Jekyll build environment:

• Ruby
• RubyGems
• GCC
• Make

See Jekyll installation guide for detailed instructions.

1. Clone your repository:

   git clone https://github.com/USERNAME/USERNAME.github.io.git
   cd USERNAME.github.io

2. Start Jekyll livereload server:

   bash run_server.sh

3. Open http://127.0.0.1:4000 in your browser

4. The server will automatically reload when you modify source files

5. Commit and push your changes:

   git add .
   git commit -m "Update homepage"
   git push

• Theme Customization Guide - Detailed guide on customizing colors and styles
• Jekyll Documentation
• Markdown Guide

This project is licensed under the MIT License - see the LICENSE file for details.

ScholarPages is built upon and inspired by excellent open-source projects:

• AcadHomepage - The original template that inspired ScholarPages (MIT License)
• Minimal Mistakes - Jekyll theme that influenced the design (MIT License)
• Academic Pages - Academic homepage template (MIT License)

If you find this template useful, please consider giving it a star! ⭐

If you have any questions or suggestions, please:

• Open an Issue
• Submit a Pull Request

Made with ❤️ for the academic community