academicpages.github.io

Github Pages template based upon HTML and Markdown for personal, portfolio-based websites.

14,975

28,882

14,975

View on GitHub

Top Related Projects

hugo-blox-builder

8,710

🚨 GROW YOUR AUDIENCE WITH HUGOBLOX! 🚀 HugoBlox is an easy, fast no-code website builder for researchers, entrepreneurs, data scientists, and developers. Build stunning sites in minutes. 适合研究人员、企业家、数据科学家和开发者的简单快速无代码网站构建器。用拖放功能、可定制模板和内置SEO工具快速创建精美网站！

theme-academic-cv

4,443

🎓 无需编写任何代码即可轻松创建漂亮的学术网站 Easily create a beautiful academic résumé or educational website using Hugo and GitHub. No code.

minimal-mistakes

13,081

:triangular_ruler: Jekyll theme for building a personal site, blog, project documentation, or portfolio.

al-folio

13,671

A beautiful, simple, clean, and responsive Jekyll theme for academics

resume-template

1,912

:page_facing_up::briefcase::tophat: A simple Jekyll + GitHub Pages powered resume template.

Quick Overview

AcademicPages is a GitHub Pages template for academic websites. It's based on the Minimal Mistakes Jekyll theme and designed to be easily customizable for personal academic sites, featuring sections for publications, talks, teaching, and a blog.

Pros

Easy to set up and deploy using GitHub Pages
Customizable with minimal coding knowledge required
Includes built-in sections for common academic content (publications, talks, etc.)
Responsive design that works well on various devices

Cons

Limited design flexibility compared to custom-built websites
Requires some familiarity with GitHub and Markdown
May not be suitable for complex academic websites with advanced features
Customization beyond the provided options may require Jekyll knowledge

Getting Started

Fork the academicpages/academicpages.github.io repository to your GitHub account.
Rename the repository to yourusername.github.io.
Edit the _config.yml file to customize your site's settings:

title: Your Name
email: your.email@example.com
description: >- # this means to ignore newlines until "baseurl:"
  Your personal academic website.
url: "https://yourusername.github.io"
twitter_username: yourtwitter
github_username:  yourgithub

Update the content in the _pages directory to add your personal information, publications, talks, etc.
Commit and push your changes to GitHub. Your site will be available at https://yourusername.github.io.

For more detailed instructions and customization options, refer to the README.md file in the repository.

Competitor Comparisons

hugo-blox-builder

8,710

Pros of hugo-blox-builder

Built with Hugo, offering faster build times and better performance
More flexible and customizable with a modular widget system
Actively maintained with regular updates and new features

Cons of hugo-blox-builder

Steeper learning curve, especially for those unfamiliar with Hugo
Requires more setup and configuration compared to academicpages
May have compatibility issues with some existing Jekyll-based content

Code Comparison

academicpages (Jekyll):

---
layout: archive
title: "Publications"
permalink: /publications/
author_profile: true
---

{% for post in site.publications reversed %}
  {% include archive-single.html %}
{% endfor %}

hugo-blox-builder (Hugo):

{{ define "main" }}
  {{ partial "page_header.html" . }}
  <div class="universal-wrapper">
    {{ with .Content }}
    <div class="article-style">{{ . }}</div>
    {{ end }}
    {{ $paginator := .Paginate .Data.Pages }}
    {{ range $paginator.Pages }}
      {{ partial "li_compact" . }}
    {{ end }}
  </div>
{{ end }}

The hugo-blox-builder code demonstrates more flexibility in layout and pagination, while academicpages relies on Jekyll's simpler templating system.

theme-academic-cv

4,443

🎓 无需编写任何代码即可轻松创建漂亮的学术网站 Easily create a beautiful academic résumé or educational website using Hugo and GitHub. No code.

Pros of theme-academic-cv

More modern and actively maintained, with regular updates and improvements
Built on Hugo, offering faster build times and better performance
Extensive documentation and a larger community for support

Cons of theme-academic-cv

Steeper learning curve, especially for those unfamiliar with Hugo
Requires more setup and configuration compared to the simpler academicpages

Code Comparison

academicpages:

# Site Settings
locale: "en-US"
title: "Your Name / Site Title"
title_separator: "-"
name: "Your Name"
description: "Personal website"

theme-academic-cv:

# Site settings
title: 'Academic'
date_format: 'Jan 2, 2006'
math: true
highlight: true
highlight_languages:
  - r

The code snippets show configuration differences, with theme-academic-cv offering more granular control over site settings and features.

minimal-mistakes

13,081

:triangular_ruler: Jekyll theme for building a personal site, blog, project documentation, or portfolio.

Pros of minimal-mistakes

More versatile and customizable, suitable for various types of websites
Regularly updated with new features and improvements
Extensive documentation and community support

Cons of minimal-mistakes

Steeper learning curve for beginners
Requires more setup and configuration for academic purposes
May have unnecessary features for simple academic websites

Code comparison

minimal-mistakes:

# Site Settings
locale: "en-US"
title: "My Awesome Site"
description: "This is my custom website"
url: "https://mysite.com"
repository: "username/repo-name"

academicpages:

# Site Settings
title: Your Name
email: your.name@example.com
description: >- # this means to ignore newlines until "baseurl:"
  Write an awesome description for your new site here.
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site

Both repositories use YAML configuration files, but minimal-mistakes offers more detailed settings out-of-the-box, while academicpages focuses on essential academic website elements.

al-folio

13,671

A beautiful, simple, clean, and responsive Jekyll theme for academics

Pros of al-folio

More modern and visually appealing design
Better support for dark mode and color customization
Integrated blog functionality with tags and categories

Cons of al-folio

Steeper learning curve for setup and customization
Requires more technical knowledge to maintain and update
Less straightforward integration with GitHub Pages

Code Comparison

academicpages.github.io:

# Site Settings
locale: "en-US"
title: "Your Name / Site Title"
title_separator: "-"
name: "Your Name"
description: "personal description"

al-folio:

# -----------------------------------------------------------------------------
# Site settings
# -----------------------------------------------------------------------------

title: blank # the website title (if blank, full name will be used instead)
first_name: You
middle_name: R.
last_name: Name
email: you@example.com

Both repositories provide templates for academic personal websites, but they differ in their approach and features. academicpages.github.io offers a simpler setup process and is more beginner-friendly, while al-folio provides a more modern design and advanced customization options at the cost of increased complexity.

resume-template

1,912

:page_facing_up::briefcase::tophat: A simple Jekyll + GitHub Pages powered resume template.

Pros of resume-template

Simpler and more focused on creating a resume-style website
Easier to customize for non-academic users
More visually appealing default design

Cons of resume-template

Less feature-rich compared to academicpages
Not specifically tailored for academic users
Fewer built-in sections for publications, talks, and teaching

Code Comparison

resume-template:

# Site settings
title: "Jekyll Resume Template"
description: "A resume template for Jekyll and GitHub Pages sites."

# Build settings
markdown: kramdown
sass:
  sass_dir: _sass
  style: compressed

academicpages:

# Site Settings
locale: "en-US"
title: "Your Name / Site Title"
title_separator: "-"
name: &name "Your Name"
description: &description "personal description"
url: https://academicpages.github.io
baseurl: "" # the subpath of your site, e.g. "/blog"

Both repositories use Jekyll and GitHub Pages, but academicpages offers more comprehensive configuration options tailored for academic websites. resume-template provides a simpler setup focused on creating a resume-style site. The code snippets show differences in the basic site configuration, with academicpages offering more detailed settings for academic users.

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

Academic Pages

Academic Pages is a GitHub Pages template for personal and professional portfolio-oriented websites.

Academic Pages template example

Getting Started

Register a GitHub account if you don't have one and confirm your e-mail (required!)
Click the "Use this template" button in the top right.
On the "New repository" page, enter your public repository name as "[your GitHub username].github.io", which will also be your website's URL.
Set site-wide configuration and add your content.
Upload any files (like PDFs, .zip files, etc.) to the files/ directory. They will appear at https://[your GitHub username].github.io/files/example.pdf.
Check status by going to the repository settings, in the "GitHub pages" section
(Optional) Use the Jupyter notebooks or python scripts in the markdown_generator folder to generate markdown files for publications and talks from a TSV file.

See more info at https://academicpages.github.io/

Running locally

When you are initially working on your website, it is very useful to be able to preview the changes locally before pushing them to GitHub. To work locally you will need to:

Clone the repository and made updates as detailed above.

Using a different IDE

Make sure you have ruby-dev, bundler, and nodejs installed

On most Linux distribution and Windows Subsystem Linux the command is:
```
sudo apt install ruby-dev ruby-bundler nodejs
```
If you see error Unable to locate package ruby-bundler, Unable to locate package nodejs , run the following:
```
sudo apt update && sudo apt upgrade -y
```
then try run sudo apt install ruby-dev ruby-bundler nodejs again.

On MacOS the commands are:
```
brew install ruby
brew install node
gem install bundler
```
Run bundle install to install ruby dependencies. If you get errors, delete Gemfile.lock and try again.

If you see file permission error like Fetching bundler-2.6.3.gem ERROR: While executing gem (Gem::FilePermissionError) You don't have write permissions for the /var/lib/gems/3.2.0 directory. or Bundler::PermissionError: There was an error while trying to write to /usr/local/bin. Install Gems Locally (Recommended):
```
bundle config set --local path 'vendor/bundle'
```
then try run bundle install again. If succeeded, you should see a folder called vendor and .bundle.
Run jekyll serve -l -H localhost to generate the HTML and serve it from localhost:4000 the local server will automatically rebuild and refresh the pages on change. You may also try bundle exec jekyll serve -l -H localhost to ensure jekyll to use specific dependencies on your own local machine.

If you are running on Linux it may be necessary to install some additional dependencies prior to being able to run locally: sudo apt install build-essential gcc make

Using Docker

Working from a different OS, or just want to avoid installing dependencies? You can use the provided Dockerfile to build a container that will run the site for you if you have Docker installed.

You can build and execute the container by running the following command in the repository:

chmod -R 777 .
docker compose up

You should now be able to access the website from localhost:4000.

Using the DevContainer in VS Code

If you are using Visual Studio Code you can use the Dev Container that comes with this Repository. Normally VS Code detects that a development coontainer configuration is available and asks you if you want to use the container. If this doesn't happen you can manually start the container by F1->DevContainer: Reopen in Container. This restarts your VS Code in the container and automatically hosts your academic page locally on http://localhost:4000. All changes will be updated live to that page after a few seconds.

Maintenance

Bug reports and feature requests to the template should be submitted via GitHub. For questions concerning how to style the template, please feel free to start a new discussion on GitHub.

This repository was forked (then detached) by Stuart Geiger from the Minimal Mistakes Jekyll Theme, which is Â© 2016 Michael Rose and released under the MIT License (see LICENSE.md). It is currently being maintained by Robert Zupko and additional maintainers would be welcomed.

Bugfixes and enhancements

If you have bugfixes and enhancements that you would like to submit as a pull request, you will need to fork this repository as opposed to using it as a template. This will also allow you to synchronize your copy of template to your fork as well.

Unfortunately, one logistical issue with a template theme like Academic Pages that makes it a little tricky to get bug fixes and updates to the core theme. If you use this template and customize it, you will probably get merge conflicts if you attempt to synchronize. If you want to save your various .yml configuration files and markdown files, you can delete the repository and fork it again. Or you can manually patch.

Top Related Projects

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot