A Github Pages template for academic websites. This 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.
I think I’ve got things running smoothly and fixed some major bugs, but feel free to file issues or make pull requests if you want to improve the generic template / theme.
Note: if you are using this repo and now get a notification about a security vulnerability, delete the Gemfile.lock file.
- Register a GitHub account if you don’t have one and confirm your e-mail (required!)
- Fork this repository by clicking the “fork” button in the top right.
- Go to the repository’s settings (rightmost item in the tabs that start with “Code”, should be below “Unwatch”). Rename the repository “[your GitHub username].github.io”, which will also be your website’s URL.
- Set site-wide configuration and create content & metadata (see below — also see this set of diffs showing what files were changed to set up an example site for a user with the username “getorg-testacct”)
- 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_generatorfolder to generate markdown files for publications and talks from a TSV file.
See more info at https://academicpages.github.io/
To run locally (not on GitHub Pages, to serve on your own computer)
- Clone the repository and made updates as detailed above
- Make sure you have ruby-dev, bundler, and nodejs installed:
sudo apt install ruby-dev ruby-bundler nodejs
bundle cleanto clean up the directory (no need to run
bundle installto install ruby dependencies. If you get errors, delete Gemfile.lock and try again.
bundle exec jekyll liveserveto generate the HTML and serve it from
localhost:4000the local server will automatically rebuild and refresh the pages on change.
Changelog — bugfixes and enhancements
There is one logistical issue with a ready-to-fork template theme like academic pages that makes it a little tricky to get bug fixes and updates to the core theme. If you fork this repository, customize it, then pull again, you’ll probably get merge conflicts. 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.
To support this, all changes to the underlying code appear as a closed issue with the tag ‘code change’ — get the list here. Each issue thread includes a comment linking to the single commit or a diff across multiple commits, so those with forked repositories can easily identify what they need to patch.