A Jekyll theme for academic sites.
Created by Eric M. Fink, based on alshedivat/al-folio, using elements from clayh53/tufte-jekyll (figures, and side/margin notes in the style of Edward Tufte and andhart/bijou (table and button styles)
- Pandoc: https://pandoc.org/
- pandoc-sidenote: https://github.com/jez/pandoc-sidenote
- Edit
_config.yml
:
- Edit the
url:
,baseurl:
,title:
, anddescription:
with the applicable information for your site. - Edit the
author:
block with your name, institutional affiliation, job title, and contact details. - Edit the
course:
block with the relevant information for your course (if applicable). You can delete this block if you are not making a course website. - In the
transfer:
block of the#deployment
settings, edit thedestination
to use your GitHub Pages username instead ofEricMFink
. This is used by therakefile
when building your site and pushing it to the GitHubPages branch.
-
Edit
.yml
files in_data directory
with the appropriate information for your classes, publications, social networks, and pages you want to be listed in your site's navigation menu. -
Edit files in
_pages
directory with the appropriate content for your site. -
Edit files in
_layouts
as desired to modify page styles and content.
To use this theme for a GitHub Pages site, you must publish your site from a gh-pages
branch:
- Optional: To use
EricMFink/Akademicky
as a remote Jekyll theme, uncommentremote_theme
line in_config.yml
file. - Commit all changes to
main
branch locally and push to remotemain
branch to GitHub. - Run the
rakefile
, usingrake
command. This will build the site, commit it to thegh-pages`` branch locally, and push it to the remote
gh-pages`` branch on GitHub.- The
rakefile
uses information entered underdeployment
in your site's_config.yml
file, so be sure you have entered that information correctly.
- The