chaudinh / chaudinh.github.io

my place!

Jekyll Academic

Jekyll Academic is a lightweight theme for any academic usecase. Perfect for portfolio websites, blogs, and academia. It is a simple no nonsense theme that offers many features.

Live preview

• Ultra-fast serving times, only ~2.6kb of CSS
• 99/100 Performance on Lighthouse
• 100/100 SEO on Lighthouse
• RSS and JSON feed
• Enhanced Markdown (Highlightjs, MathJax, ChartJs, FontAwesome/Bootstrap Icons)
• Optional Disqus comments
• Search bar with blog categorisation based on tags
• Custom 404 page
• SEO optimised (robots.txt, sitemap.xml, jekyll-seo-tag)

Contents

• Jekyll Academic
  • Contents
  • Installation
    • Quick install
    • Longer installation process
  • Usage
  • Contributing
  • License

Installation

Quick install

$ curl -s -L https://raw.githubusercontent.com/yak-fumblepack/jekyll-academic/master/scripts/bundle-install.sh | bash

Longer installation process

Add this to your Jekyll site's Gemfile:

gem "jekyll-academic"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-academic

Then execute:

$ bundle install

or install it yourself as a Gem:

$ gem install jekyll-academic

OR

$ git clone https://github.com/yak-fumblepack/jekyll-academic.git

$ bundle install

Then finally to view your site (default is localhost:4000):

$ bundle exec jekyll serve

Usage

To make it yours, edit the _config.yml file or refer to our docs for further configuration.

Have fun building your amazing site!

Contributing

Bugfixes and features are most welcome and appreciated. For features and bugfixes, please make the pull request onto the dev branch. If you're looking to improve the documentation, make the pull request onto docs-pages.

Is there a bug? Feel free to open an issue.

Development

Fork this repo

$ git clone https://github.com/yak-fumblepack/jekyll-academic.git/
$ cd jekyll-academic/
$ bundle install
$ bundle exec jekyll serve

And view it on localhost:4000

Then make your amazing contributions and changes!

License

This project is licensed under MIT. See LICENSE file for more details.