forked from academicpages/academicpages.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
245926c
commit e78f77a
Showing
47 changed files
with
6,300 additions
and
10,404 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,77 @@ | ||
| 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. | ||
| # Academic Pages | ||
| **Academic Pages is a Github Pages template for academic websites.** | ||
|
|
||
| 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 | ||
| # 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 | ||
|
|
||
| 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. Clone the repository and made updates as detailed above. | ||
| 1. Make sure you have ruby-dev, bundler, and nodejs installed | ||
|
|
||
| On most Linux distribution and [Windows Subsystem Linux](https://learn.microsoft.com/en-us/windows/wsl/about) the command is: | ||
| ```bash | ||
| sudo apt install ruby-dev ruby-bundler nodejs | ||
| ``` | ||
| On MacOS the commands are: | ||
| ```bash | ||
| brew install ruby | ||
| brew install node | ||
| gem install bundler | ||
| ``` | ||
| 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 -H localhost` to generate the HTML and serve it from `localhost:4000` the local server will automatically rebuild and refresh the pages on change. | ||
|
|
||
| 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` | ||
|
|
||
| ## Using Docker | ||
|
|
||
| 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](https://www.docker.com/) installed. | ||
|
|
||
| Start by build the container: | ||
|
|
||
| ```bash | ||
| docker build -t jekyll-site . | ||
| ``` | ||
|
|
||
| Next, run the container: | ||
| ```bash | ||
| docker run -p 4000:4000 --rm -v $(pwd):/usr/src/app jekyll-site | ||
| ``` | ||
|
|
||
| # 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. | ||
|
|
||
| ## Bugfixes and enhancements | ||
|
|
||
| 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. | ||
|
|
||
| # Changelog -- bugfixes and enhancements | ||
| 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. | ||
|
|
||
| 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. | ||
| --- | ||
| <div align="center"> | ||
|
|
||
|  | ||
| [](https://github.com/academicpages/academicpages.github.io/graphs/contributors) | ||
| [](https://github.com/academicpages/academicpages.github.io/releases/latest) | ||
| [](https://github.com/academicpages/academicpages.github.io/blob/master/LICENSE) | ||
|
|
||
| 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. | ||
| [](https://github.com/academicpages/academicpages.github.io) | ||
| [](https://github.com/academicpages/academicpages.github.io/fork) | ||
| </div> |
Oops, something went wrong.