Github Pages template for academic personal websites, forked from mmistakes/minimal-mistakes
JavaScript CSS HTML Jupyter Notebook Python Ruby
Switch branches/tags
Nothing to show
Clone or download
Latest commit 0513790 May 5, 2018
Permalink
Failed to load latest commit information.
_data Update navigation.yml Sep 19, 2016
_drafts clone from staeiou.github.io Sep 15, 2016
_includes Support MathJax for rendering equations. Feb 26, 2018
_layouts fix teaching "Published in" bug Jul 21, 2017
_pages fix link typo Mar 27, 2017
_portfolio Update portfolio-2.html Sep 21, 2016
_posts add generic examples Sep 18, 2016
_publications modify examples to reflect output of new markdown_generator scripts Mar 28, 2017
_sass image back to 175% Jul 19, 2017
_talks modify examples to reflect output of new markdown_generator scripts Mar 28, 2017
_teaching Update 2015-spring-teaching-2.md Jan 13, 2017
assets Add Academicons Jul 17, 2017
files rename publications to files Sep 19, 2016
images Add files via upload Feb 14, 2017
markdown_generator update to reflect completed documentation Mar 28, 2017
talkmap add talkmap files Sep 19, 2016
.gitignore Ignore the _site/ directory for local builds. Mar 25, 2017
CHANGELOG.md clone from staeiou.github.io Sep 15, 2016
CONTRIBUTING.md add info about tagging code changes Jul 21, 2017
Gemfile implement liveserve Feb 18, 2018
LICENSE clone from staeiou.github.io Sep 15, 2016
README.md add Gemfile.lock notice May 6, 2018
_config.dev.yml clone from staeiou.github.io Sep 15, 2016
_config.yml disable read more links by default Jul 26, 2017
package.json clone from staeiou.github.io Sep 15, 2016
talkmap.ipynb move talkmap.ipynb out of _talks Sep 20, 2016
talkmap.py .py version of talkmap.ipynb Jan 13, 2017

README.md

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.

Instructions

  1. Register a GitHub account if you don't have one and confirm your e-mail (required!)
  2. Fork this repository by clicking the "fork" button in the top right.
  3. 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.
  4. 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")
  5. 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.
  6. Check status by going to the repository settings, in the "GitHub pages" section
  7. (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/

To run locally (not on GitHub Pages, to serve on your own computer)

  1. Clone the repository and made updates as detailed above
  2. Make sure you have ruby-dev, bundler, and nodejs installed: sudo apt install ruby-dev ruby-bundler nodejs
  3. Run bundle clean to clean up the directory (no need to run --force)
  4. Run bundle install to install ruby dependencies. If you get errors, delete Gemfile.lock and try again.
  5. Run bundle exec jekyll liveserve to generate the HTML and serve it from localhost:4000 the 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.