Skip to content

Commit

Permalink
let's update
Browse files Browse the repository at this point in the history
  • Loading branch information
soodoku committed Feb 18, 2024
1 parent 5a9b549 commit ec0f7d6
Show file tree
Hide file tree
Showing 72 changed files with 8,552 additions and 8,426 deletions.
484 changes: 0 additions & 484 deletions CHANGELOG.md

This file was deleted.

9 changes: 6 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
Contributions are welcome! Please add issues and make pull requests. There are no stupid questions. All ideas are welcome. This is a volunteer project. Be excellent to each other.
Contributions are welcome!

Fork from master and go from there. This repository is intended to remain a generic, ready-to-fork template that demonstrates the features of academicpages.
Please add issues and make pull requests. There are no stupid questions. All ideas are welcome. This is a volunteer project. Be excellent to each other.

Bug reports and feature requests to the template should be [submitted via GitHub](https://github.com/academicpages/academicpages.github.io/issues/new/choose). For questions concerning how to style the template, please feel free to start a [new discussion on GitHub](https://github.com/academicpages/academicpages.github.io/discussions).

Fork from master and go from there. Remember that this repository is intended to remain a generic, ready-to-fork template that demonstrates the features of academicpages.

If you make a pull request and change code, please make sure there is a closed issue tagged with 'code change' that has some comment linking to either the single commit (if the change was just one commit) or a diff comparing before/after the change (see [issue 21](https://github.com/academicpages/academicpages.github.io/issues/21) for example). This is so that those who have forked this repo and modified it for their purposes can more easily patch bugs and new features.
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@ group :jekyll_plugins do
gem "jekyll-feed"
gem 'jekyll-sitemap'
gem 'hawkins'
gem "webrick", "~> 1.8"
end
40 changes: 25 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,41 @@
A Github Pages template for academic websites. This was forked (then detached) by [Stuart Geiger](https://github.com/staeiou) from the [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/), 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.
# Academic Pages

### Note: if you are using this repo and now get a notification about a security vulnerability, delete the Gemfile.lock file.
![pages-build-deployment](https://github.com/academicpages/academicpages.github.io/actions/workflows/pages/pages-build-deployment/badge.svg)

# Instructions
Academic Pages is a Github Pages template for academic websites.


# Getting Started

1. Register a GitHub account if you don't have one and confirm your e-mail (required!)
1. Fork [this repository](https://github.com/academicpages/academicpages.github.io) by clicking the "fork" button in the top right.
1. 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.
1. Set site-wide configuration and create content & metadata (see below -- also see [this set of diffs](http://archive.is/3TPas) showing what files were changed to set up [an example site](https://getorg-testacct.github.io) for a user with the username "getorg-testacct")
1. 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. Click the "Use this template" button in the top right.
1. On the "New repository" page, enter your repository name as "[your GitHub username].github.io", which will also be your website's URL.
1. Set site-wide configuration and add your content.
1. 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, in the "GitHub pages" section
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/

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

1. Clone the repository and made updates as detailed above
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:

1. Clone the repository and made updates as detailed above.
1. Make sure you have ruby-dev, bundler, and nodejs installed: `sudo apt install ruby-dev ruby-bundler nodejs`
1. Run `bundle clean` to clean up the directory (no need to run `--force`)
1. Run `bundle install` to install ruby dependencies. If you get errors, delete Gemfile.lock and try again.
1. 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.
1. Run `jekyll serve -l` to generate the HTML and serve it from `localhost:4000` the local server will automatically rebuild and refresh the pages on change.


# Maintenance

Bug reports and feature requests to the template should be [submitted via GitHub](https://github.com/academicpages/academicpages.github.io/issues/new/choose). For questions concerning how to style the template, please feel free to start a [new discussion on GitHub](https://github.com/academicpages/academicpages.github.io/discussions).

This repository was forked (then detached) by [Stuart Geiger](https://github.com/staeiou) from the [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/), which is © 2016 Michael Rose and released under the MIT License (see LICENSE.md). It is currently being maintained by [Robert Zupko](https://github.com/rjzupkoii) and additional maintainers would be welcomed.

# Changelog -- bugfixes and enhancements
## 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.
If you have bugfixes and enhancements that you would like to submit as a pull request, you will need to [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) this repository as opposed to using it as a template. This will also allow you to [synchronize your copy](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) of template to your fork as well.

To support this, all changes to the underlying code appear as a closed issue with the tag 'code change' -- get the list [here](https://github.com/academicpages/academicpages.github.io/issues?q=is%3Aclosed%20is%3Aissue%20label%3A%22code%20change%22%20). 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.
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.
112 changes: 67 additions & 45 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,73 @@
# For technical reasons, this file is *NOT* reloaded automatically when you use
# `jekyll serve`. If you change this file, please restart the server process.

# Site Settings
# Basic Site Settings
locale : "en-US"
title : "Donald P. Green"
title : "Your Name / Site Title"
title_separator : "-"
name : &name "Donald Green"
description : &description "Professor of Political Science"
name : &name "Your Name"
description : &description "personal description"
url : https://academicpages.github.io # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"
baseurl : "" # the subpath of your site, e.g. "/blog"
repository : "donalpgreen/donalpgreen.github.io"
repository : "academicpages/academicpages.github.io"

# Site Author - The following control what appear as part of the author content on the side bar.
# If a field is blank the icon and link will not appear, otherwise it will be shown.
# Additional customization can be done by editing /_includes/author-profile.html
author:
# Biographic information
avatar : "profile.png"
name : "Your Sidebar Name"
pronouns : # example: "she/her"
bio : "Short biography for the left-hand sidebar"
location : "Earth"
employer : "Red Brick University"
uri : # URL
email : "none@example.org"

# Academic websites
arxiv : # URL - Update with the correct link to your profile
googlescholar : "https://scholar.google.com/citations?user=PS_CX0AAAAAJ"
impactstory : # URL
orcid : "http://orcid.org/yourorcidurl"
pubmed : "https://www.ncbi.nlm.nih.gov/pubmed/?term=john+snow"
researchgate : # URL

# Repositories and software development
bitbucket : # Username - Update with your username on the site
codepen : # Username
dribbble : # Username
github : "academicpages"
kaggle : # Username
stackoverflow : # User number or user number and name (i.e., use "1" or "1/jeff-atwood")

# Social media
bluesky : "bsky.app" # Replace this with you Bluesky username
facebook : # Username
flickr : # Username
foursquare : # Username
goodreads : # Username
google_plus : # Username
keybase : # Username
instagram : # Username
lastfm : # Username
linkedin : # Username
mastodon : # URL
medium : # URL
pinterest : # Username
soundcloud : # Username
steam : # Username
telegram : # URL
tumblr : # Username
twitter : "UniofOxford" # Replace this with your X / Twitter handle
vine : # Username
weibo : # Username
wikipedia : # Username
xing : # Username
youtube : # Username


# Site Settings
teaser : # filename of teaser fallback teaser image placed in /images/, .e.g. "500x300.png"
breadcrumbs : false # true, false (default)
words_per_minute : 160
Expand Down Expand Up @@ -49,12 +107,14 @@ staticman:
atom_feed:
path : # blank (default) uses feed.xml


# SEO Related
google_site_verification :
bing_site_verification :
alexa_site_verification :
yandex_site_verification :


# Social Sharing
twitter:
username : &twitter
Expand All @@ -73,50 +133,11 @@ social:

# Analytics
analytics:
provider : "google-universal" # false (default), "google", "google-universal", "custom"
provider : "google-universal" # false (default), "google", "google-universal", "google-analytics-4", "custom"
google:
tracking_id :


# Site Author
author:
name : "Donald Green"
avatar : "profile.png"
bio : "Donald P. Green is J.W. Burgess Professor of Political Science at Columbia University"
location : "NY, US"
employer : "Columbia University"
pubmed : ""
googlescholar : "https://scholar.google.com/citations?user=e4KiJasAAAAJ&hl=en&oi=ao"
email :
researchgate : # example: "https://www.researchgate.net/profile/yourprofile"
uri :
bitbucket :
codepen :
dribbble :
flickr :
facebook :
foursquare :
github : "donalpgreen"
google_plus :
keybase :
instagram :
impactstory : #"https://profiles.impactstory.org/u/xxxx-xxxx-xxxx-xxxx"
lastfm :
linkedin :
orcid : "https://orcid.org/0000-0002-8850-438X"
pinterest :
soundcloud :
stackoverflow : # http://stackoverflow.com/users/123456/username
steam :
tumblr :
twitter : "donaldpgreen"
vine :
weibo :
xing :
youtube :
wikipedia :


# Reading Files
include:
- .htaccess
Expand Down Expand Up @@ -245,6 +266,7 @@ defaults:
author_profile: true
share: true


# Sass/SCSS
sass:
sass_dir: _sass
Expand Down
22 changes: 14 additions & 8 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
# main links links
main:
- title: "Woodworking"
url: https://www.rachelcollet.com/Galleries/Architectureanddesign/Don-wood-work/n-NM8fgw
- title: "Publications"
url: /publications/

- title: "Courses"
url: /courses/
- title: "Talks"
url: /talks/

- title: "Teaching"
url: /teaching/

- title: "Games/OCTII"
url: https://boardgamegeek.com/boardgamedesigner/229/don-green-i
- title: "Portfolio"
url: /portfolio/

- title: "Blog Posts"
url: /year-archive/

- title: "CV"
url: /cv/

- title: "Books"
url: https://www.amazon.com/stores/Donald-P.-Green/author/B001HCVQEY
- title: "Guide"
url: /markdown/
8 changes: 8 additions & 0 deletions _includes/analytics-providers/google-analytics-4.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<script async src="https://www.googletagmanager.com/gtag/js?id={{site.analytics.google.tracking_id}}"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', '{{site.analytics.google.tracking_id}}');
</script>
2 changes: 2 additions & 0 deletions _includes/analytics.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
{% include /analytics-providers/google.html %}
{% when "google-universal" %}
{% include /analytics-providers/google-universal.html %}
{% when "google-analytics-4" %}
{% include /analytics-providers/google-analytics-4.html %}
{% when "custom" %}
{% include /analytics-providers/custom.html %}
{% endcase %}
Expand Down
Loading

0 comments on commit ec0f7d6

Please sign in to comment.