Skip to content

Commit

Permalink
Merge branch 'master' of github.com:satyamtransformer/satyamtransform…
Browse files Browse the repository at this point in the history
…er.github.io
  • Loading branch information
“Satyam committed Sep 30, 2024
2 parents 5049ec6 + 15477f7 commit 541127e
Show file tree
Hide file tree
Showing 64 changed files with 643 additions and 2,849 deletions.
10 changes: 9 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Ignore the contents of the _site directory
# Ignore the contents of the _site directory and other cache directories
_site/
.sass-cache/

# Ignore the directory for local files during development
local/

# Ignore the Gemfile that is generated
Gemfile.lock

# Ingore files created by npm
node_modules
package-lock.json
24 changes: 24 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Base image: Ruby with necessary dependencies for Jekyll
FROM ruby:3.2

# Install dependencies
RUN apt-get update && apt-get install -y \
build-essential \
nodejs \
&& rm -rf /var/lib/apt/lists/*

# Set the working directory inside the container
WORKDIR /usr/src/app

# Copy Gemfile and Gemfile.lock into the container (necessary for `bundle install`)
COPY Gemfile Gemfile.lock ./

# Install bundler and dependencies
RUN gem install bundler:2.3.26 && bundle install

# Expose port 4000 for Jekyll server
EXPOSE 4000

# Command to serve the Jekyll site
CMD ["bundle", "exec", "jekyll", "serve", "--host", "0.0.0.0", "--watch"]

31 changes: 7 additions & 24 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,28 +1,11 @@
source "https://rubygems.org"
source 'https://rubygems.org'

# Hello! This is where you manage which Jekyll version is used to run.
# When you want to use a different version, change it below, save the
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
#
# bundle exec jekyll serve
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!

gem "github-pages", group: :jekyll_plugins

# If you want to use Jekyll native, uncomment the line below.
# To upgrade, run `bundle update`.

# gem "jekyll"

gem "wdm", "~> 0.1.0" if Gem.win_platform?

# If you have any plugins, put them here!
group :jekyll_plugins do
# gem "jekyll-archives"
gem "jekyll-feed"
gem 'jekyll'
gem 'jekyll-feed'
gem 'jekyll-sitemap'
gem 'hawkins'
gem "webrick", "~> 1.8"
gem 'jemoji'
gem 'webrick', '~> 1.8'
end

gem 'github-pages'
56 changes: 45 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,58 @@

# Academic Pages

![pages-build-deployment](https://github.com/academicpages/academicpages.github.io/actions/workflows/pages/pages-build-deployment/badge.svg)

Academic Pages is a Github Pages template for academic websites.

**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. 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. 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/

## Running Locally
## 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. 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 `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.

# Maintenance
Start by build the container:

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).
```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.

Expand All @@ -39,3 +61,15 @@ This repository was forked (then detached) by [Stuart Geiger](https://github.com
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.

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.

---
<div align="center">

![pages-build-deployment](https://github.com/academicpages/academicpages.github.io/actions/workflows/pages/pages-build-deployment/badge.svg)
[![GitHub contributors](https://img.shields.io/github/contributors/academicpages/academicpages.github.io.svg)](https://github.com/academicpages/academicpages.github.io/graphs/contributors)
[![GitHub release](https://img.shields.io/github/v/release/academicpages/academicpages.github.io)](https://github.com/academicpages/academicpages.github.io/releases/latest)
[![GitHub license](https://img.shields.io/github/license/academicpages/academicpages.github.io?color=blue)](https://github.com/academicpages/academicpages.github.io/blob/master/LICENSE)

[![GitHub stars](https://img.shields.io/github/stars/academicpages/academicpages.github.io)](https://github.com/academicpages/academicpages.github.io)
[![GitHub forks](https://img.shields.io/github/forks/academicpages/academicpages.github.io)](https://github.com/academicpages/academicpages.github.io/fork)
</div>
13 changes: 0 additions & 13 deletions _config.dev.yml

This file was deleted.

52 changes: 33 additions & 19 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ author:
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
Expand Down Expand Up @@ -70,8 +71,16 @@ author:
wikipedia : # Username
xing : # Username
youtube : # Username
zhihu : # URL
zhihu : # Username

# Publication Category - The following the list of publication categories and their headings
publication_category:
books:
title: 'Books'
manuscripts:
title: 'Journal Articles'
conferences:
title: 'Conference Papers'

# Site Settings
teaser : # filename of teaser fallback teaser image placed in /images/, .e.g. "500x300.png"
Expand Down Expand Up @@ -107,6 +116,7 @@ staticman:
options:
format : "iso8601" # "iso8601" (default), "timestamp-seconds", "timestamp-milliseconds"
atom_feed:
hide : false # change to true to hide the RSS feed in the footer
path : # blank (default) uses feed.xml


Expand Down Expand Up @@ -135,7 +145,7 @@ social:

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

Expand All @@ -150,23 +160,26 @@ exclude:
- "*.sublime-workspace"
- .asset-cache
- .bundle
- .github
- .jekyll-assets-cache
- .sass-cache
- CHANGELOG
- Capfile
- Gemfile
- Gruntfile.js
- LICENSE
- README
- Rakefile
- assets/js/_main.js
- assets/js/plugins
- assets/js/vendor
- CHANGELOG
- Capfile
- config
- Dockerfile
- Gemfile
- Gruntfile.js
- gulpfile.js
- LICENSE
- local
- log
- node_modules
- package.json
- package.json*
- Rakefile
- README
- tmp
- vendor
keep_files:
Expand Down Expand Up @@ -196,7 +209,7 @@ kramdown:
enable_coderay: false


# Collections
# These settings control the types of collections used by the template
collections:
teaching:
output: true
Expand All @@ -212,7 +225,7 @@ collections:
permalink: /:collection/:path/


# Defaults
# These settings control how pages and collections are included in the site
defaults:
# _posts
- scope:
Expand Down Expand Up @@ -279,22 +292,23 @@ sass:
permalink: /:categories/:title/
# paginate: 5 # amount of posts to show
# paginate_path: /page:num/
timezone: America/Los_Angeles # http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
timezone: Etc/UTC # http://en.wikipedia.org/wiki/List_of_tz_database_time_zones


# Plugins
plugins:
- jekyll-feed
- jekyll-gist
- jekyll-paginate
- jekyll-sitemap
- jekyll-gist
- jekyll-feed
- jekyll-redirect-from
# mimic GitHub Pages with --safe
- jemoji

# Mimic GitHub Pages with --safe
whitelist:
- jekyll-feed
- jekyll-gist
- jekyll-paginate
- jekyll-sitemap
- jekyll-gist
- jekyll-feed
- jemoji


Expand Down
7 changes: 6 additions & 1 deletion _data/navigation.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# main links links
# The following is the order of the links in the header of the website.
#
# Changing the order here will adjust the order and you can also add additional
# links. Removing a link prevents it from showing in the header, but does not
# prevent it from being included in the site.

main:
- title: "Publications"
url: /publications/
Expand Down
Loading

0 comments on commit 541127e

Please sign in to comment.