|
1 | | -# Academic Pages |
2 | | -**Academic Pages is a GitHub Pages template for personal and professional portfolio-oriented websites.** |
3 | | - |
4 | | - |
5 | | - |
6 | | -# Getting Started |
7 | | - |
8 | | -1. Register a GitHub account if you don't have one and confirm your e-mail (required!) |
9 | | -1. Click the "Use this template" button in the top right. |
10 | | -1. On the "New repository" page, enter your public repository name as "[your GitHub username].github.io", which will also be your website's URL. |
11 | | -1. Set site-wide configuration and add your content. |
12 | | -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. |
13 | | -1. Check status by going to the repository settings, in the "GitHub pages" section |
14 | | -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. |
15 | | - |
16 | | -See more info at https://academicpages.github.io/ |
17 | | - |
18 | | -## Running locally |
19 | | - |
20 | | -When you are initially working on 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: |
21 | | - |
22 | | -1. Clone the repository and made updates as detailed above. |
23 | | - |
24 | | -### Using a different IDE |
25 | | -1. Make sure you have ruby-dev, bundler, and nodejs installed |
26 | | - |
27 | | - On most Linux distribution and [Windows Subsystem Linux](https://learn.microsoft.com/en-us/windows/wsl/about) the command is: |
28 | | - ```bash |
29 | | - sudo apt install ruby-dev ruby-bundler nodejs |
30 | | - ``` |
31 | | - If you see error `Unable to locate package ruby-bundler`, `Unable to locate package nodejs `, run the following: |
32 | | - ```bash |
33 | | - sudo apt update && sudo apt upgrade -y |
34 | | - ``` |
35 | | - then try run `sudo apt install ruby-dev ruby-bundler nodejs` again. |
36 | | - |
37 | | - On MacOS the commands are: |
38 | | - ```bash |
39 | | - brew install ruby |
40 | | - brew install node |
41 | | - gem install bundler |
42 | | - ``` |
43 | | -1. Run `bundle install` to install ruby dependencies. If you get errors, delete Gemfile.lock and try again. |
44 | | - |
45 | | - If you see file permission error like `Fetching bundler-2.6.3.gem ERROR: While executing gem (Gem::FilePermissionError) You don't have write permissions for the /var/lib/gems/3.2.0 directory.` or `Bundler::PermissionError: There was an error while trying to write to /usr/local/bin.` |
46 | | - Install Gems Locally (Recommended): |
47 | | - ```bash |
48 | | - bundle config set --local path 'vendor/bundle' |
49 | | - ``` |
50 | | - then try run `bundle install` again. If succeeded, you should see a folder called `vendor` and `.bundle`. |
51 | | -
|
52 | | -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. |
53 | | - You may also try `bundle exec jekyll serve -l -H localhost` to ensure jekyll to use specific dependencies on your own local machine. |
54 | | -
|
55 | | -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` |
56 | | -
|
57 | | -## Using Docker |
58 | | -
|
59 | | -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. |
60 | | -
|
61 | | -You can build and execute the container by running the following command in the repository: |
62 | | -
|
63 | | -```bash |
64 | | -chmod -R 777 . |
65 | | -docker compose up |
66 | | -``` |
67 | | -
|
68 | | -You should now be able to access the website from `localhost:4000`. |
69 | | -
|
70 | | -### Using the DevContainer in VS Code |
71 | | -
|
72 | | -If you are using [Visual Studio Code](https://code.visualstudio.com/) you can use the [Dev Container](https://code.visualstudio.com/docs/devcontainers/containers) that comes with this Repository. Normally VS Code detects that a development coontainer configuration is available and asks you if you want to use the container. If this doesn't happen you can manually start the container by **F1->DevContainer: Reopen in Container**. This restarts your VS Code in the container and automatically hosts your academic page locally on http://localhost:4000. All changes will be updated live to that page after a few seconds. |
73 | | -
|
74 | | -# Maintenance |
75 | | -
|
76 | | -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). |
77 | | -
|
78 | | -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. |
79 | | -
|
80 | | -## Bugfixes and enhancements |
81 | | -
|
82 | | -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. |
83 | | -
|
84 | | -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. |
85 | | -
|
86 | | ---- |
87 | | -<div align="center"> |
88 | | - |
89 | | - |
90 | | -[](https://github.com/academicpages/academicpages.github.io/graphs/contributors) |
91 | | -[](https://github.com/academicpages/academicpages.github.io/releases/latest) |
92 | | -[](https://github.com/academicpages/academicpages.github.io/blob/master/LICENSE) |
93 | | -
|
94 | | -[](https://github.com/academicpages/academicpages.github.io) |
95 | | -[](https://github.com/academicpages/academicpages.github.io/fork) |
96 | | -</div> |
| 1 | +Website for me!git |
0 commit comments