academicpages /academicpages.github.io

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

★ 17,827⑂ 10,212👁 113⑃ 3,075● 465▤ 7
SCSSMITCreated 2016-09-15academicpages.github.io
下载:v0.9v0.9 ↓0.92026-06-24
+5
日增长
17,827
stars
10,212
forks
113
watchers
3,075
prs
465
issues
7
releases

README

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

!Academic Pages template example

 Getting Started

1. Register a GitHub account if you don't have one and confirm your e-mail (required!)
1. Click the "Use this template" button in the top right.
1. On the "New repository" page, enter your public repository name as "[your GitHub username].github.io", which will also be your website's URL.
1. Edit site-wide configuration in _config.yml and double check that the url is the one that you just selected in the previous step and that repository reflects the correct path for your repository.
1. Add your site 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.
1. Check status by going to the repository settings, under: Settings - Pages - Source: GitHub Actions
1. (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/

 Additional Tutorials

Additional tutorials for working with the Academic Pages template can be found at the following sites:
- https://jayrobwilliams.com/posts/2020/06/academic-website/

 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:

1. Clone the repository and made updates as detailed above.

 Using a different IDE
1. Make sure you have ruby-dev, bundler, and nodejs installed
    
    On most Linux distributions and Windows Subsystem Linux the command is:
    bash
    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:
    bash
    sudo apt update && sudo apt upgrade -y
    
    then try running sudo apt install ruby-dev ruby-bundler nodejs again.

    On MacOS the commands are:
    bash
    brew install ruby
    brew install node
    gem install bundler
    
1. 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):
    bash
    bundle config set --local path 'vendor/bundle'
    
    then try run bundle install again. If succeeded, you should see a folder called vendor and .bundle.

1. Run npm run build to generate the minimized version of the JavaScript files used by the template. This command will create the file assets/js/main.min.js, which is excluded from the repository in favor of building 

Top issues

Discussions

Latest release

v0.9 v0.9 2026-06-24
This stable release of the template greatly improves the overall responsiveness of the template when loading while continuing to support the features introduced in previous v0.8.x minor releases. 

 What's Changed
 Fix theme toggle issue by defining browserPref before use by @ferrolho in https://github.com/academicpages/academicpages.github.io/pull/3142
 Update .gitignore to prevent manual update site from fail to build using Github actions by @quangbhdang in https://github.com/academicpages/academicpages.github.io/pull/3171
 _includes/footer.html: Fix site last updated template by @hosie

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON