kabhijit
/
JekyllHomepage2025
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

release candidate upgrade notes

This commit is contained in:
jcraitz 2021-06-15 15:56:11 -04:00
parent 8eebdf7a90
commit c3a8a5182a
3 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Gemfile
View File

@ -1,6 +1,6 @@
source "https://rubygems.org"
gem "jekyll"
gem "jekyll", "~> 4.0"
gem "jekyll-sitemap"
gem "jekyll-seo-tag"
gem "jekyll-gist"

2
Gemfile.lock
View File

@ -104,7 +104,7 @@ PLATFORMS
ruby
DEPENDENCIES
jekyll
jekyll (~> 4.0)
jekyll-gist
jekyll-seo-tag
jekyll-sitemap

16
README.md
View File

@ -6,3 +6,19 @@ By using this template you will have a website that is well designed, easy to ma
## [Getting Started Guide](https://ncsu-libraries.github.io/jekyll-academic-docs/)
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/](https://ncsu-libraries.github.io/jekyll-academic-docs/).
## 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](https://git-scm.com/book/en/v2/Git-Tools-Submodules). 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](https://revealjs.com/upgrading/) 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`