Git Product home page Git Product logo

academicpages.github.io's Introduction

Academic Pages

pages-build-deployment

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!)
  2. Click the "Use this template" button in the top right.
  3. On the "New repository" page, enter your repository name as "[your GitHub username].github.io", which will also be your website's URL.
  4. Set site-wide configuration and add your content.
  5. 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.
  6. Check status by going to the repository settings, in the "GitHub pages" section
  7. (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

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.
  2. Make sure you have ruby-dev, bundler, and nodejs installed: sudo apt install ruby-dev ruby-bundler nodejs
  3. Run bundle install to install ruby dependencies. If you get errors, delete Gemfile.lock and try again.
  4. 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-essentials gcc make

Maintenance

Bug reports and feature requests to the template should be submitted via GitHub. For questions concerning how to style the template, please feel free to start a new discussion on GitHub.

This repository was forked (then detached) by Stuart Geiger from the Minimal Mistakes Jekyll Theme, which is © 2016 Michael Rose and released under the MIT License (see LICENSE.md). It is currently being maintained by Robert Zupko 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 this repository as opposed to using it as a template. This will also allow you to synchronize your copy 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.

academicpages.github.io's People

Contributors

a-paxton avatar aki-nishimura avatar amyzlc avatar bhavberi avatar bp-high avatar bxie avatar carreau avatar cifkao avatar hainesr avatar jacksonpradolima avatar jacobtfisher avatar jayrobwilliams avatar johnhandleyd avatar kc9jud avatar luismmontilla avatar maxgalindo150 avatar mborowczak avatar mohit-15 avatar naveenarun avatar ning-y avatar qaisjp avatar rjzupkoii avatar staeiou avatar sukkaw avatar tlcaputi avatar yimingzhaomath avatar zuoxingdong avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

academicpages.github.io's Issues

When setting future: false, posts with today's date aren't posted

I create a new post like this:


title: 'Domain Adaptation'
date: 2012-11-10
permalink: /posts/domain-adaptation/
tags:

  • machine learning
  • domain adaptation

It creates a posts folder in _site and works but when I change the dates to:


title: 'Domain Adaptation'
date: 2017-11-10
permalink: /posts/domain-adaptation/
tags:

  • machine learning
  • domain adaptation

The posts folder disappears and posts dont show up on the website.

Disqus comment doesn't show

Hi, Thanks for this awesome framework. I tried to add Disqus comment in my blog posts, but it doesn't show. I added Disqus and my username in Disqus in the _config.yml file:

comments:
  provider               : "disqus" # false (default), "disqus", "discourse", "facebook", "google-plus", "staticman", "custom"
  disqus:
    shortname            : "xxx"

The short name I added was actually my username in Disqus , I don't know what shortname mean.
Here is the link for my _config.yml file.

How to remove the "Recommended citation: " string

I want to remove this string. I edited the file "publications.py" and changed the line

md += "\nRecommended citation: " + item.citation

to

md += "\n" + item.citation

But I still see this string in my publication page.
Thanks

Sass 4.0 deprecated function call.

when running jekyll serve I get the following warnings:
DEPRECATION WARNING: Passing a string to call() is deprecated and will be illegal
in Sass 4.0. Use call(get-function("variable-exists")) instead.`

This was reported in the original minimal mistakes them and fixed, check here.

jekyll serve locally

I am unable to run the site locally. Jekyll serve requires bundle install.

bundle install fails on dependencies:

Could not find gem 'jekyll-sitemap (= 0.10.0) x64-mingw32', which is required by gem 'github-pages', in any
of the sources.

Render python code blocks

It seems it doesn't support rendering python code blocks in blog posts e.g.

import numpy as np

print(np.random.randint(1, 10, 10))

images not showing in sidebar

I have placed my profile picture in images folder and updated config.yml so that avatar has my image name, I am still not able to see my images, however if I put the names of the file which were there by default (i.e profile.png, etc..) it seems to work.

Please help

E: Unable to locate package ruby-bundler

After running sudo apt install ruby-dev ruby-bundler nodejs, or more specifically sudo apt install ruby-bundler, the following error is thrown: E: Unable to locate package ruby-bundler. Debian 8 Jessie.

Publication Categorization

How to categorize the Publication as a journal and conferences. When I add the publication based on the journal and the conference it should appear.

Example.
Publication:
Journal
1.
2.
Conferences
1.
2.

how to do this?

Talks display issue

Hello there,

Thank you for creating and sharing this Jekyll theme! It is just what I've been looking for.

I don't now if you can assist me or not but I'm having a challenging time trying to get my talks to display. Instead of seeing text on my cv.html page, I just see empty bullets. I would appreciate any troublehshooting hints you might have.

CV webpage
https://willtm.github.io/cv/

Forked repository
https://github.com/willtm/willtm.github.io

All the best,

Will

Adding blogposts

Hey I added blogpost files in the /_posts folder. Here's an example:


title: 'The Heights of Ignorance'
date: 2016-04-05
permalink: /posts/2015/07/On Writing/

...(text)...

But when I add these files, the posts folder doesn't update them.

Any help on how this works? My repo is at: https://github.com/siddsach/siddsach.github.io

Talk map does not work properly

Hi there,

I run the script, and it detects the location. However the map just show the name of the city, not other information of the talk. See the picture attached:

captura de pantalla 2017-07-26 a les 12 58 28

It is because there is missing information in the talks? I just checked and it seems to have the necessary info in each talk.

The repository address is https://github.com/jaruizso/jaruizso.github.io

Support Jupyter notebooks / .ipynb files

Provide some scaffolded support for uploading .ipynb Jupyter notebooks and displaying them. Current options for presenting Jupyter notebooks are all based on linking to some nbconvert-based output. nbconvert does have a --to markdown option, but GitHub pages wouldn't run nbconvert on push. So this would likely be a script / notebook that would be run by a user when adding an .ipynb file to the repository, which calls nbconvert to generate the markdown file in the appropriate folder, then adding appropriate YAML metadata.

This would also need a defined way to for users to point to where .ipynb files are located and specify metadata.

Where to modify sidebar and How to remove sitemap

I want to show my email address not just a link, but also I want the whole address appears on the website as well. Also, I'm wondering how to hide the sitemap at the bottom of the webpage. Thanks for the help.

Subtitles in Navigation Menu

I was wondering if there was an easy way to add sub menu items?
I've been trying to cobble it together from other sources (i.e. Link) but am not too familiar with Jekyll and the like. Might be a nice addition.

_publications, navigation.yml, about.md not updating properly?

For some reason when I update the forked version of the site in my repository, everything does not seem to update (except for what is in the _config.yml file). I'm following the basic differences in the documentation provided here http://archive.is/3TPas. Is this a bug or am I doing something completely wrong. Sorry I'm quite new to github, so its all a bit unfamiliar to me and a bit hard for me to tell what I am doing wrong.

The files I have modified are only:
_config.yml (which worked),
_publications: adding files to it (didn't work),
_pages/about.md: modifying the text in it (didn't work)
_data/navigation.yml: deleting headings from (didn't work)

strangly the about.md file updating did work several hours ago, but when I retried recently it didn't work

Images not showing in blog _posts

I am looking to add images in my blog post. I placed the corresponding image in the images/ folder and included the following line in markdown file in _posts/.
![](../images/DP1.png)

I am able to see the image in my atom editor, but when I push the changes and refresh the webpage, I do not see it in the blog. Any idea how to resolve this?
Note: I even tried placing the image in the _posts/ directory and modified the line to
![](DP1.png)
but it doesn't work.

CV page doesn't properly display talks

Looks like an HTML tag isn't closed somewhere. All the talk section is one giant link to the first talk. Some theme-specific closing HTML tags are displaying, which they shouldn't.

Compatibility with SASS 4.0

I just forked this for my personal website (looks/behaves amazing! thanks!!) :-)

Disclaimer: I'm not at all familiar with ruby; maybe the problem is on my environment!

When I $ jekyll serve, I get thrown a lot of warnings regarding incompatibility with SASS 4.0.

DEPRECATION WARNING: Passing a string to call() is deprecated and will be illegal
in Sass 4.0. Use call(get-function("variable-exists")) instead.

This seems to have already been fixed in minimal-mistakes, and seems to be related to the version of susy bundled in the repo:
mmistakes/minimal-mistakes#1114

Add an html file in blog post

I'm building my github.io page and I'm planning to add few of my jupyter notebooks as html files to the blog post section.

However I'm not able to add html file in the markdown.

Is it possible to add html in markdown?

Remove "Published in" in both Teaching and Publication section

Thank you very much for developing this website template. It is really useful and in good-to-go format. A thing I couldn't figure out is how to remove "Published in" this line in both Teaching and Publication sections. It appears to be generated by venue: in the md files. Commenting them out doesn't help and will still generate a new "Published" logo in the webpage. Could you advise how to resolve this issue? Having "Published in" in Teaching section seems a bit weird.

Thanks a lot!

Update script & notebook that converts CSV to talks & publication markdown files

These scripts in markdown_generator are what I used on staeiou.github.io, and I've made improvements to academicpages since then. I'm not sure if they work out of the box, and they aren't documented very well. Also, the source CSV should be updates so they generate the files in academicpages, rather than the ones from my site.

Blog templates for on GitHub Pages

I am looking for a turn key template like the example blog. - remove spaces in the url "dm rn etlist.cf"
Blog templates for on GitHub Pages.

I love your template. I am new. How can I get a blank start to your template ...

??? What are you using to edit
??? What did you use to create

fix publication.md

should add this to the file to make your google scholar profile link shown

{% include base_path %}

{% if page.author and site.data.authors[page.author] %}
  {% assign author = site.data.authors[page.author] %}{% else %}{% assign author = site.author %}
{% endif %}

Sigma.js on academicpapers

Hi there,

I am tryng to use sigma.js on my website, but I cannot make it work. So actually I dont know if the fork (from minimal mistakes) supports javascript. In theory yes, but I am not very familiar with javascript, so probably I am missing something.

What i have done is to insert the sigma.js folder in my repository: https://github.com/jaruizso/jaruizso.github.io

Then i try to make a test by running it on jaruizso.github.io/teaching with the following code:

captura de pantalla 2017-07-28 a les 12 32 27

npm is installed and I can run it on my computer.

PS: Sorry for three issues in a row, I am setting up the web these days.

Publication and teaching entries in CV should be ordered reversely in time

Publication list is ordered reversely in time (recent publication first) in the "Publications" page, but not so in the "CV" page.

In publications.md

{% for post in site.publications reversed %}
  {% include archive-single.html %}
{% endfor %}

In cv.md

  <ul>{% for post in site.publications %}
    {% include archive-single-cv.html %}
  {% endfor %}</ul>

I think the default style in cv.md should be changed to match publications.md.

How to add a new page

I'd like to create an off-topic page.

I created an _offtopic folder and add a few files under it. I also updated navigation.yml and created offtopic.html file.

When I want to access the files under _offtopic folder

{% include base_path %}

{% for post in site.offtopic reversed %}
  {% include archive-single.html %}
{% endfor %}

the page looks empty.

How can I fix this?

make picture larger

How can we easily adjust the size of the profile photo? The default is quite small...

Google scholar link points at author.uri

Hi,

Many thanks for sharing this super-userful template! Just found that the Google Scholar link in the sidebar doesn't point to the google scholar profile introduced in the googlescholar field in _config.yml, but to the content of author.uri (seen in _includes/author-profiles.html line 104). Shouldn't this be author.googlescholar instead?

references

Hello, I was wondring if there is an elegant way how to add references in the text. So far I am just using hyperlinks to DOIs, but that is not optimal. I found some bibtex flavoured markdowns, another solution that I find quite ok is though footnotes.

Is there a way how to make scientific references in your template?

P.S. Thanks a lot, it is a great template. I am playing it continuously for last four days (you can check out my webpage!).

default code block font-size too small

The default code block font-size was defined as $type-size-7 in _sass/_syntax.scss. This is too small compared with the normal text font.

I'd recommend changing it to 0.8125em (~13 px), which is between $type-size-5 (~16 px) and $type-size-6 (~12 px).

  .highlight {
    margin: 0;
    font-family: $monospace;
    font-size: .8125em;  /* was $type-size-7 */
    line-height: 1.8;
  }

External link in a picture

I have create a table on the front page with 4 logos (images) and I am tryng to add a link, so people can click on them. However unsuccessfully.

captura de pantalla 2017-07-27 a les 11 14 54

The pictures look ok on the website with that code, but is there any way to introduce a link on them?

captura de pantalla 2017-07-27 a les 11 30 53

I tried with the following and several combinations, but does not work:

[http://www.epsanet.org](/images/epsa.png)

![http://www.epsanet.org](/images/epsa.png)

How to enable google anlalytics?

First of all, thank you for this excellent template. I just customized it to my own need (https://yongyao.github.io/). One thing I want to ask is what is the best way to enable google analytics or any other type of watching function in this template? I saw there is an analytics folder in the code base.

page not built correctly

Hi,
thank you for making this, I just forked the repo, and changed only the name of the repo and _config.yml file

repository               : "https://github.com/crazyhottommy/mingtang"

it shows me:
screenshot 2017-05-02 14 28 51

any ideas?
Tommy

run locally on windows 7

How to run the following line on the win7
1.Make sure you have ruby-dev, bundler, and nodejs installed: sudo apt install ruby-dev ruby-bundler nodejs
2.Run bundle clean to clean up the directory (no need to run --force)
3.Run bundle install to install ruby dependencies. If you get errors, delete Gemfile.lock and try again.
4.Run bundle exec jekyll serve to generate the HTML and serve it from localhost:4000

Using pagination

Hi!

I'm trying to use this template but I don't know how to use it with pagination.

with:

paginate: 5
paginate_path: "/page:num/"
in _config.yml file 

I always receive the warning Pagination:

Pagination is enabled, but I couldn't find an index.html page to use as the pagination template. Skipping pagination.

I saw that there is a file called "pagination.html". How should I use it with the archive template?

Thank you!

Not loading for custom domain

Hi,
I have added a custom domain to github. When I push your jekyll files to my repository, my .github.io site is working but my custom domain site is showing 404 error.
Any help would be appreciated.

A issue about ./Gemfile.lock

Hi, I fork the code and commit my one, but I get the alert, I do not know how to fix it. I totally have zero knowledge about javascript. Could you give me a hand?
The code is here: [https://github.com/Yuyang01/yuyang01.github.io]

**We found a potential security vulnerability in one of your dependencies.
A dependency defined in ./Gemfile.lock has known security vulnerabilities and should be updated.

Only the owner of this repository can see this message.
Learn more about vulnerability alerts**

Support better way for forked repositories to update core theme patches

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.

I'm not sure what the best way is to support this, so for now, I'm curating a manually-curated list of bugs that have been fixed since this project was released, currently in README.md. If you have a bug, you can go through and manually update. But if you have a better idea about how to support this, please let me know!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.