Skip to content

Commit 2294af1

Browse files
learning-github-zgylearning-github-zgy
authored
Initial commit
0 parents  commit 2294af1

File tree

302 files changed

+29560
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

302 files changed

+29560
-0
lines changed

‎.devcontainer/devcontainer.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"name": "ACADEMIC PAGES",
3+
"dockerComposeFile": "../docker-compose.yaml",
4+
"service": "jekyll-site",
5+
"remoteEnv": {
6+
"VSCODE_SERVER_DIR": "/home/vscode/.vscode-server"
7+
},
8+
"runArgs": [
9+
"--user",
10+
"1000:1000"
11+
],
12+
"workspaceFolder": "/usr/src/app",
13+
"remoteUser": "vscode",
14+
"forwardPorts": [4000] // Add port forwarding
15+
}

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/workflows/scrape_talks.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Scrape Talk Locations
2+
3+
on:
4+
push:
5+
paths:
6+
- 'talks/**'
7+
- 'talkmap.ipynb'
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v2
15+
16+
- name: Set up Python
17+
uses: actions/setup-python@v2
18+
with:
19+
python-version: '3.9' # Specify the Python version you need
20+
21+
- name: Install dependencies
22+
run: |
23+
pip install jupyter pandas requests beautifulsoup4 geopy # Add other dependencies as needed
24+
pip install getorg --upgrade
25+
26+
- name: Run Jupyter Notebook
27+
run: |
28+
jupyter nbconvert --to notebook --execute talkmap.ipynb --output talkmap_out.ipynb
29+
30+
- name: Commit changes
31+
run: |
32+
git config user.name "github-actions[bot]"
33+
git config user.email "github-actions[bot]@users.noreply.github.com"
34+
git add .
35+
git commit -m "Automated update of talk locations" || echo "No changes to commit"
36+
git push

‎.gitignore

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Ignore the contents of the _site directory and other cache directories
2+
_site/
3+
.sass-cache/
4+
5+
# Ignore the directory for local files during development
6+
local/
7+
8+
# Ignore the Gemfile that is generated
9+
Gemfile.lock
10+
11+
# Ingore files created by npm
12+
node_modules
13+
package-lock.json

‎CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Contributions are welcome!
2+
3+
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.
4+
5+
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).
6+
7+
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.
8+

‎Dockerfile

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Base image: Ruby with necessary dependencies for Jekyll
2+
FROM ruby:3.2
3+
4+
# Install dependencies
5+
RUN apt-get update && apt-get install -y \
6+
build-essential \
7+
nodejs \
8+
&& rm -rf /var/lib/apt/lists/*
9+
10+
11+
# Create a non-root user with UID 1000
12+
RUN groupadd -g 1000 vscode && \
13+
useradd -m -u 1000 -g vscode vscode
14+
15+
# Set the working directory
16+
WORKDIR /usr/src/app
17+
18+
# Set permissions for the working directory
19+
RUN chown -R vscode:vscode /usr/src/app
20+
21+
# Switch to the non-root user
22+
USER vscode
23+
24+
# Copy Gemfile into the container (necessary for `bundle install`)
25+
COPY Gemfile ./
26+
27+
28+
29+
# Install bundler and dependencies
30+
RUN gem install connection_pool:2.5.0
31+
RUN gem install bundler:2.3.26
32+
RUN bundle install
33+
34+
# Command to serve the Jekyll site
35+
CMD ["jekyll", "serve", "-H", "0.0.0.0", "-w", "--config", "_config.yml,_config_docker.yml"]
36+

‎Gemfile

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
source 'https://rubygems.org'
2+
3+
group :jekyll_plugins do
4+
gem 'jekyll'
5+
gem 'jekyll-feed'
6+
gem 'jekyll-sitemap'
7+
gem 'jekyll-redirect-from'
8+
gem 'jemoji'
9+
gem 'webrick', '~> 1.8'
10+
end
11+
12+
gem 'github-pages'
13+
gem 'connection_pool', '2.5.0'

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016 Michael Rose
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Academic Pages
2+
**Academic Pages is a GitHub Pages template for personal and professional portfolio-oriented websites.**
3+
4+
![Academic Pages template example](images/homepage.png "Academic Pages template example")
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 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 open `.gitignore` then add `vendor` inside it.
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+
![pages-build-deployment](https://github.com/academicpages/academicpages.github.io/actions/workflows/pages/pages-build-deployment/badge.svg)
90+
[![GitHub contributors](https://img.shields.io/github/contributors/academicpages/academicpages.github.io.svg)](https://github.com/academicpages/academicpages.github.io/graphs/contributors)
91+
[![GitHub release](https://img.shields.io/github/v/release/academicpages/academicpages.github.io)](https://github.com/academicpages/academicpages.github.io/releases/latest)
92+
[![GitHub license](https://img.shields.io/github/license/academicpages/academicpages.github.io?color=blue)](https://github.com/academicpages/academicpages.github.io/blob/master/LICENSE)
93+
94+
[![GitHub stars](https://img.shields.io/github/stars/academicpages/academicpages.github.io)](https://github.com/academicpages/academicpages.github.io)
95+
[![GitHub forks](https://img.shields.io/github/forks/academicpages/academicpages.github.io)](https://github.com/academicpages/academicpages.github.io/fork)
96+
</div>

0 commit comments

Comments
 (0)