Skip to content

Github Pages template for academic personal websites, forked from mmistakes/minimal-mistakes

License

Notifications You must be signed in to change notification settings

pranav-satheesh/pranav-satheesh.github.io

 
 

Repository files navigation

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.

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.

About

Github Pages template for academic personal websites, forked from mmistakes/minimal-mistakes

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 39.1%
  • HTML 22.0%
  • SCSS 19.7%
  • Jupyter Notebook 11.8%
  • Python 4.5%
  • CSS 2.7%
  • Ruby 0.2%