Skip to content

Update Template #2892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 32 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
_site/
*.DS_Store

31 changes: 6 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,12 @@
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.

### Note: if you are using this repo and now get a notification about a security vulnerability, delete the Gemfile.lock file.

# Instructions
[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
[![Open in Visual Studio Code](https://img.shields.io/badge/Editor-VSCode-blue?style=flat-square&logo=visual-studio-code&logoColor=white)](https://github.dev/ArianeDlns/ArianeDlns.github.io/tree/main)

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. 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.
[![screenshot](images/screenshot_CV.png)](https://arianedlns.github.io/)

See more info at https://academicpages.github.io/
## License

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

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.

# Changelog -- bugfixes and enhancements
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.

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.
## Thanks

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.
31 changes: 31 additions & 0 deletions README_original.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
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.

### Note: if you are using this repo and now get a notification about a security vulnerability, delete the Gemfile.lock file.

# Instructions

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

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.

# Changelog -- 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.

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.
44 changes: 22 additions & 22 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
# `jekyll serve`. If you change this file, please restart the server process.

# Site Settings
locale : "en-US"
title : "Your Name / Site Title"
locale : "en-EN"
title : "Ariane Dlns"
title_separator : "-"
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"
name : &name "Ariane Dlns"
description : &description "Data Scientist @ BCG Gamma | Centrale Paris | ESSEC "
url : https://arianedlns.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 : "academicpages/academicpages.github.io"
repository : "ArianeDlns/https://arianedlns.github.io/"
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 @@ -80,36 +80,36 @@ analytics:

# Site Author
author:
name : "Your Sidebar Name"
name : "Ariane Dlns"
avatar : "profile.png"
bio : "Your biography for the left-hand sidebar"
location : "Location"
bio : "Data Scientist @ BCG Gamma Centrale Paris | ESSEC "
location : "Paris Saclay University"
employer :
pubmed : "https://www.ncbi.nlm.nih.gov/pubmed/?term=john+snow"
googlescholar : "http://yourfullgooglescholarurl.com"
email :
pubmed : #"https://www.ncbi.nlm.nih.gov/pubmed/?term=john+snow"
googlescholar : #"http://yourfullgooglescholarurl.com"
email : "[email protected]"
researchgate : # example: "https://www.researchgate.net/profile/yourprofile"
uri :
uri : # https://arianedlns.fr/portfolio/
bitbucket :
codepen :
dribbble :
flickr :
facebook :
foursquare :
github : "academicpages"
github : "ArianeDlns"
google_plus :
keybase :
instagram :
impactstory : #"https://profiles.impactstory.org/u/xxxx-xxxx-xxxx-xxxx"
lastfm :
linkedin :
orcid : "http://orcid.org/yourorcidurl"
linkedin : https://www.linkedin.com/in/ariane-dalens/
orcid : #"http://orcid.org/yourorcidurl"
pinterest :
soundcloud :
stackoverflow : # http://stackoverflow.com/users/123456/username
steam :
tumblr :
twitter : "replacethistwitterhandle"
twitter :
vine :
weibo :
xing :
Expand Down Expand Up @@ -199,7 +199,7 @@ defaults:
layout: single
author_profile: true
read_time: true
comments: true
comments: false
share: true
related: true
# _pages
Expand All @@ -217,7 +217,7 @@ defaults:
layout: single
author_profile: true
share: true
comments: true
comments: false
# _publications
- scope:
path: ""
Expand All @@ -226,16 +226,16 @@ defaults:
layout: single
author_profile: true
share: true
comments: true
comments: false
# _portfolio
- scope:
path: ""
type: portfolio
values:
layout: single
author_profile: true
share: true
comment: true
share: false
comment: false
# _talks
- scope:
path: ""
Expand Down
6 changes: 3 additions & 3 deletions _data/authors.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Authors

Name Name:
name : "Name Name"
uri : "http://name.com"
email : "name@name.com"
name : "Ariane Dlns"
uri : "https://arianedlns.github.io"
email : "arianedlns@gmail.com"
bio : "This is the first name."
avatar : "bio-photo-2.jpg"
twitter : "name"
Expand Down
23 changes: 7 additions & 16 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,13 @@
# main links links
main:
- title: "Publications"
url: /publications/

- title: "Talks"
url: /talks/
- title: "CV"
url: cv/

- title: "Teaching"
url: /teaching/

- title: "Portfolio"
url: /portfolio/
url: portfolio/

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

- title: "CV"
url: /cv/
#- title: "Blog Posts"
# url: /year-archive/

- title: "Guide"
url: /markdown/
#- title: "Guide"
# url: markdown/
2 changes: 1 addition & 1 deletion _includes/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
{% if site.author.bitbucket %}
<li><a href="http://bitbucket.org/{{ site.author.bitbucket }}"><i class="fab fa-bitbucket" aria-hidden="true"></i> Bitbucket</a></li>
{% endif %}
<li><a href="{% if site.atom_feed.path %}{{ site.atom_feed.path }}{% else %}{{ base_path }}/feed.xml{% endif %}"><i class="fa fa-fw fa-rss-square" aria-hidden="true"></i> {{ site.data.ui-text[site.locale].feed_label | default: "Feed" }}</a></li>
<!-- <li><a href="{% if site.atom_feed.path %}{{ site.atom_feed.path }}{% else %}{{ base_path }}/feed.xml{% endif %}"><i class="fa fa-fw fa-rss-square" aria-hidden="true"></i> {{ site.data.ui-text[site.locale].feed_label | default: "Feed" }}</a></li> -->
</ul>
</div>

Expand Down
2 changes: 1 addition & 1 deletion _includes/footer/custom.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!-- start custom footer snippets -->
<a href="/sitemap/">Sitemap</a>
<!-- <a href="/sitemap/">Sitemap</a> -->
<!-- end custom footer snippets -->
4 changes: 3 additions & 1 deletion _includes/seo.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@
{% endif %}
{% assign seo_url = seo_url | default: site.github.url %}

{% if page.title %}
{% if page.title and page.author_profile != true %}
{% assign seo_title = page.title | append: " " | append: site.title_separator | append: " " | append: site.title %}
{% elsif page.title and page.author_profile == true %}
{% assign seo_title = "Ariane \| Profile" %}
{% endif %}

{% if seo_title %}
Expand Down
Loading