lions-jekyll-theme

This is a Jekyll theme build for my website. It is based upon the minima Jekyll theme with some major modifications.

This project is still in development, but is functional enough for my website. If anyone is interested in this project, see the Contributing section.

• Installation
  • Gemfile
  • Remote Theme
  • Install Yourself
• Usage
  • Config Information
  • Layouts
• Contributing
• Development
• License

Add this line to your Jekyll site's Gemfile:

gem "lions-jekyll-theme"

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

theme: lions-jekyll-theme

And then execute:

$ bundle

Add this line to your Jekyll site's Gemfile:

gem "jekyll-remote-theme"

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

remote_theme: Lion4567714/lions-jekyll-theme

$ gem install lions-jekyll-theme

Much of the basic website information is stored in your _config.yml file. The following fields are used by this theme:

author:
    profile_picture: "path/to/your/pfp"
    name: your name
    username: your username

socials:
    - { platform: email/github/linkedin, 
        preview: "preview text", 
        link: "hyperlink" }
    - ...

title: site title
email: your email
desciption: site description

header_pages:
    - .md files to show on the header 
    - (e.g. index.md, about_me.md)

Preset layouts change how your pages behave. You can change the layout of a page in the front matter of the page like so:

---
layout: home
title: Home
hyperlink: /
---

Basic head-header-body-footer layout

Home page, includes sidebar with profile picture and contact information and a list of posts.

Standard post format, mostly unchanged from minima base.

Mostly unused. For any non-post non-homepage pages.

Bug reports and pull requests are welcome on Github! This project was entirely for my own website, but if anyone is interested in this project becoming more "official" I am open to the idea.

This project is intended strictly as a Jekyll theme for usage in tandem with a Jekyll website, but it may be adapted into its own website really easily!

Set up your environment with:

$ bundle install

Then run the website with:

$ bundle exec jekyll serve

You should then be able to view the website at http://localhost:4000.

The theme is available as open source under the terms of the MIT License.