PGA Default Jekyll Theme

Features

  • Layouts:
    • Default
    • Post
    • Page
  • Design Features:
    • Bootstrap v4.x
    • Font Awesome
  • Integrations:
    • Google Analaytics
  • TODO:
    • Index Pagination
    • Mailchimp Integration?

Installation

  • Installing this theme to any Jekyll project
    • Add to Gemfile: gem "jekyll-theme-pga-default"
    • Add to _config.yml: theme: jekyll-theme-pga-default
    • $ gem install jekyll-archives

And then execute: $ bundle

Usage

YAML Post Example:


---
layout: post
title:  "We all wait for summer"
author: john
categories: [ Jekyll, project ]
image: /assets/images/5.jpg
featured: true
---

YAML Page Example:


---
layout: page
title: PGA Theme for Jekyll
---

Contributing

  • Clone the repo.
  • Create a branch off of master and give it a meaningful name (e.g. layout/faq).
  • Open a pull request on GitHub and describe the feature or fix.

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in jekyll-theme-pga-default.gemspec accordingly.

License

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