simple-gh-pages-theme

Quick installation

# 0. To create a new Jekyll site:
jekyll new <SITENAME>
cd <SITENAME>

# 1. Add this line to your Jekyll site's `Gemfile`:
gem "simple-gh-pages-theme"

# 2. Add this line to your Jekyll site's `_config.yml`. Remove/disable possibly already enabled themes:
theme: simple-gh-pages-theme

# 3. Execute on your command line:
bundle

# 4. Run install script to create 'posts.md'
bundle exec install-theme

# 5. When you now run your website locally on `http://localhost:4000`, it should show the theme:
bundle exec jekyll serve

Configuration:

All configuration options that can be overwritten can be found here.

Github Pages setup

Go to settings > page in your github-pages-repository.

1. Select source: Deploy from a branch
2. Select branch: gh-pages (create if non-existent)
3. Select /docs as folder
4. You can now run script/deploy

Posts

Create your posts (files) like:

docs/_posts/yyyy-mm-dd-postname.md

Each post can have the following (metadata) options (with example values):

layout:     post                    # OR page
title:      "Title here"            # Used for post-titles
image:      assets/images/image.png # OR images on urls like: https://example.com/image.png
categories: [category]              # 'category' can be anything
tags:       [tag]                   # 'tag' can be everything
highlight:  false                   # if true: it will listed in highlights, which can be shown with: `{% include highlights.html %}`
short:      false                   # if true: it shown in 'short' list on home page

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/LiveNL/simple-gh-pages-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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