ncsu-libraries / jekyll-academic Goto Github PK

License: MIT License

HTML 21.40% CSS 3.17% JavaScript 37.55% Ruby 0.11% SCSS 37.77%

jekyll-academic's Introduction

Introduction

This template utilizes Jekyll, an open source static website generator, as well as a theme based largely off of the Minimal Mistakes theme by Michael Rose. The purpose of this template is to provide you with a simple, well designed website that is optimized for hosting on Github pages. We aim to reduce the technological know-how and time that is usually required for maintaining a personal or professional website.

Why Should I Use This?

By using this template you will have a website that is well designed, easy to maintain, free to host and easy to update. While there are many options out there for personal and professional websites, most are dependant on the platform on which they were built, and cannot be easily migrated. This template, while built for Github Pages integration, provides flexibility should you choose to host it elsewhere.

Getting Started Guide

Complete documentation for getting started as well as advanced features of Jekyll Academic can be found at https://ncsu-libraries.github.io/jekyll-academic-docs/.

Migrating to a new default branch name

We've decided to change this project's default branch name to 'main'. If you've forked this repository prior to July 20th, 2021, then you should a message with update instructions when you go to your fork in github:

In your fork on GitHub, go to the branches view, and click on the edit icon next to the 'master' branch. Change the branch name to main. Underneath the input box where you change the name you will be presented with the commands that you will need to run on your local copy of your fork.

Upgrade Notes for June 2021 release

If you are running a fork of Jekyll Academic before June 2021, we made some breaking changes to upgrade the underlying Jekyll version and to address the constant github/dependabot security notices mentioned in issue #4.

We have updated Jekyll to version 4 and removed reveal.js as an included library. We still want to support reveal.js presentations, so we have taken the suggestion from issue #4 and made the reveal.js directory a git submodule. If you are running Jekyll Academic as a Github Page, this should hopefully be a minor change.

If, however, you are running Jekyll Academic locally or on a custom server, after merging this repo's commits in to your fork, you will need to go to the command line in your local or custom instance and perform the following command:

$ git submodule update --init

If you have any reveal.js presentations posted, you may need to make some updates for them to display properly using reveal.js version 4. See Jekyll's documentation for details.

Keeping reveal.js up to date

Moving forward, if you'd like to update reveal.js you will need to run the following commands:

$ git submodule update --remote

jekyll-academic's People

Contributors

Stargazers

Watchers

Forkers

queryluke lwrubel gwu-libraries dprn alblaine colinrnickels blros thrasymachus2017 mplearning mkudzia wallermp vlamen lillian-rigling ggruszczynski yipengqin goffinet ss4ws laderast caitlinmeyer shenkev a1ip samfearn joeweaver jmhuculak biodata-club maksimt micahvandegrift mhaidli zero-cooper bibliojo sclayton29 sseatua andreashih jsduenass software-engineering-sg-13 jftmames shadow-prince anishellore wdegotta jcraitz huhanwj df9as kkaloudis mirsadeghi monahton sarahsid10 kevinprinsloo spakan siddharthkishore cgentemann jraitz cullerth clairecahoon bettsjumpstart dhbaskaran owain-s alexreher a-lex-a masmit23 natlopez ashley999777 laurenpaljusaj gjnieveb dnoneill vistrevi tuyentruongmlis kmx1442 kristen-chua laurarus python4oceanography tcbutler320 tejasavinashshetty kavyaagarwal2001 amaze2 tmathura mi5sssss yk-ren saeediitb christinedutt1 morrislab-pc mohammadsaeedi-wrm jlfyao jesslf mkahveci jsheinbaum moyeed-hasan-talukder gwwm philcsar2 sophiebodek avicndugu kachinskea pankaj-codes

jekyll-academic's Issues

Problem with deploy to standalone webserver

Hi there,
I was giving jekyll-academic a try, and I think I stumbled upon a bug. I would like to deploy the server to a standalone web server (i.e. not host it on a github page), but I cannot visualise the site properly, regardless of what baseurl and/or url setting I add to my _config.yml file. I think the problem is related to the theme making heavy use of:

site.github.url

instead of anything like

site.baseurl

or any siting with

Is this a know/wanted feature? Or am I doing something wring? Otherwise it'd be nice to change the .html files and to add the baseurl and url settings, that I guess could indeed also point to a github page if/when needed.

Thanks, M.

Math Support

From @maristie via issue #3

Math Support
Add math support to the project. Here are two suggestions.

According to MathJax Documentation, could you please add MathJax support in _includes/_head.html or _includes/_scripts.html? ( block is preferred, though)

Or a faster math render KaTeX using the default math engine provided by Kramdown: https://kramdown.gettalong.org/math_engine/mathjax.html

View all post link not working

Link to /posts/ bring ups 404 error.

_author-bio include does not work in Firefox on Ubuntu

The contact links (email, Github, Twitter, etc.) section does not appear when using Ubuntu 16.04 LTS with Firefox 58.0.2.

Deprecated configuration, SEO suggestion and math support

Deprecated configuration

The latest Jekyll has deprecated gems (_config.yml, line 57). Could you please rename it to plugins?

SEO suggestion

In addition, is it possible to use jekyll-seo-tag in _config.yml and add {% seo %} in template files to optimize website? According to the official article,

To tell the plugin where to put your meta tag information, you must add the SEO tag right before head in your site template files. For example, in _layouts/_default.html:

<html>
  <head>
    {% include head.html %}
    {% seo %}
  </head>
</html>

Math support

According to MathJax Documentation, could you please add MathJax support in _includes/_head.html or _includes/_scripts.html? (<head> block is preferred, though)

Or a faster math render KaTeX using the default math engine provided by Kramdown: https://kramdown.gettalong.org/math_engine/mathjax.html

Thanks!

Kramdown needs updating

Remediation
Upgrade kramdown to version 2.3.0 or later. For example:

gem "kramdown", ">= 2.3.0"

Woudl it be possible for someone to do that?
cheers
Jo

Attach reveal.js directory as submodule

Is it possible to add reveal.js as a submodule? In this way users can get the latest version conveniently, and it's more structured.

Code:

# run in the root directory of the repo
$ git submodule add https://github.com/hakimel/reveal.js.git