Academic Pages is a GitHub Pages template for personal and professional portfolio-oriented websites.
files/
directory. They will appear at https://[your GitHub username].github.io/files/example.pdf.markdown_generator
folder to generate markdown files for publications and talks from a TSV file.See more info at https://academicpages.github.io/
When you are initially working 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.
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 open .gitignore
then add vendor
inside it.
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
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:
docker compose up
You should now be able to access the website from localhost:4000
.
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.
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.