jekyll-theme-prologue 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2faba1fa6337191550d9db7c66cc4b4c7ac989ae
-  data.tar.gz: d05a4cddb1fedf86fbb4df0a23b13f9c3686c6c2
+  metadata.gz: bbf9038c3f7e028a6c216c98e3407804406dbd6e
+  data.tar.gz: 2eb67f52568cddb65605bb54902f7624114054b3
 SHA512:
-  metadata.gz: f7d78fa32b210543c010d55c3e5908ebad6accf51aa331bb203c0ce9b293cc8b26ae7be943ad48d933bc8290199eade7753fec5aa64f61eb19ec7e9b4d126fc1
-  data.tar.gz: ee76f792a160034898c48d9e776d9469bcfcb8300de47dd9bcfced5de061265ed7bf781fcf89bf60501bd455f7c129b1ed815d74284200e54d530edaadbf20f5
+  metadata.gz: 28436487d239bc69fd03e0ea6615082c8833ce3b9bd414ffa3c27cfc4b5388d9707dc4ae70fef3d88ae55a698950e4137983e8fd00b6c14e3ed300e259d3c00b
+  data.tar.gz: d1e8de3048124bb6ed40b9589922b20db162e49dba705de524e5822307c34ce414c3329b8f16c1bc545c639a7fffe029659265708dc0efc144d2dbf48291c3ba

data/README.md

@@ -1,6 +1,8 @@
 # (WIP) Prologue - Jekyll Theme
 
-A Jekyll version of the "Prologue" theme by [HTML5 UP](https://html5up.net/).
+[![Gem Version](https://badge.fury.io/rb/jekyll-theme-prologue.svg)](https://badge.fury.io/rb/jekyll-theme-prologue)
+
+A Jekyll version of the responsive, single-page "Prologue" theme by [HTML5 UP](https://html5up.net/). Perfect for a streamlined portfolio.
 
 **Demo**: https://chrisbobbe.github.io/jekyll-theme-prologue/
 
@@ -10,28 +12,30 @@ A Jekyll version of the "Prologue" theme by [HTML5 UP](https://html5up.net/).
 
 There are two ways to get started:
 
-1. Fork this repository. If you want to use [GitHub Pages](https://pages.github.com/), create a branch named `gh-pages`.
+1. Fork the [GitHub repository](https://github.com/chrisbobbe/jekyll-theme-prologue). If you want to use [GitHub Pages](https://pages.github.com/), create a branch named `gh-pages`. (NOTE: The _config.yml file in this repository has `baseurl` set for my own GitHub Pages site, so you'll want to change it or make it blank.)
 2. Install the theme using the jekyll-theme-prologue gem. Instructions can be found [here](https://jekyllrb.com/docs/themes/#installing-a-theme).
 
-Your `_config.yml` file **must include the following line or it will not work**: `collections: [sections]`. An optional sample config called `_sample-config.yml` ships with the gem for your convenience. If using the gem, run `open $(bundle show jekyll-theme-prologue)` to find this file, then move it to your project directory. It will do nothing until it's renamed `_config.yml` and sits in your project's root directory.
+**The following instructions apply to this theme only.**
+
+Your `_config.yml` file **must include the following line or it will not work**: `collections: [sections]`. This tells Jekyll to look in the _sections folder (which you will create) for your content. A sample config `_config.yml` is in the GitHub repository for your reference. If using the gem, run `open $(bundle show jekyll-theme-prologue)` to find this file, then optionally move it to your project's root directory. It will do nothing until you move it there.
 
-Create a `_sections` folder in your project's root directory, or use the one in the GitHub repository, and start adding content there.
+Create a `_sections` folder in your project's root directory and start adding content. Sample content is provided in the [GitHub repository](https://github.com/chrisbobbe/jekyll-theme-prologue).
 
 All new sections should be added as html or Markdown documents in the `_sections` folder. The following section variables can be set with frontmatter:
 - `title` (required)
 - `order` (required; orders the sequence of sections on the page. Section 1 displays with banner.jpg)
 - `icon` (optional; see [Font Awesome](http://fontawesome.io/icons/) for icon codes)
-- `auto-header` (optional; "use-title" is default, "none" for no header, or custom header text in section headings)
+- `auto-header` (optional; "use-title" is default, "none" for no header, or custom header text)
 
-To set the banner image, replace `assets/images/banner.jpg` with another image with the same filename. Same for `avatar.jpg`.
+To set the banner image, overwrite `assets/images/banner.jpg`. Same for `avatar.jpg`.
 
 # Jekyll and the single-page view
 
-**This theme is designed to include all content on a single scrollable page.** That means a few things are different from what you might expect.
+**This theme is designed to include all content on a single scrollable page.** That means a few things are different from what you might expect in Jekyll.
 
-You don't need to use Jekyll's hardcoded support for `_pages` or `_posts`, and layouts aren't provided for them. Each section (intro, about me, etc.) is built from an html or Markdown document in the `_sections` folder with corresponding [frontmatter](https://jekyllrb.com/docs/frontmatter/).
+You don't need to use Jekyll's hardcoded support for `_pages` or `_posts`, and layouts aren't provided for them. Jekyll does not support multiple layout-formatted content sections per page. Each section (intro, about me, etc.) is built from an html or Markdown document in the `_sections` folder with corresponding [frontmatter](https://jekyllrb.com/docs/frontmatter/).
 
-Since Jekyll does not support multiple layout-formatted content sections per page, this theme doesn't have a `section.html` layout in the `_layouts` folder. If you're looking to customize the templates, go to `_layouts/home.html` and `_includes/section.html`.
+If you're looking to customize the templates, go to `_layouts/home.html` and `_includes/section.html`.
 
 There shouldn't be a need to set `permalink` in frontmatter because all content appears on the same page.
 
@@ -39,6 +43,7 @@ There shouldn't be a need to set `permalink` in frontmatter because all content
 
 * **[Formspree.io](https://formspree.io/) contact form integration** - just add your email to the `_config.yml` and it works!
 * Add your **social profiles** easily in `_config.yml`. Only social profiles buttons you enter in `config.yml` show up on the site footer!
+* Custom 404 page called 404.html
 
 # Credits
 

data/_config.yml

@@ -0,0 +1,67 @@
+# Developer's Note: This is a sample _config.yml file offered with
+# jekyll-theme-prologue for your convenience. To use it, move it to your
+# project's root directory. Please note that the following lines are
+# NECESSARY for Prologue to work correctly:
+# 
+# theme: jekyll-theme-prologue
+# collections: [sections]
+#
+# They activate the theme and tell Jekyll to find your content
+# in /_sections. Note where "sections" starts with an underscore
+# and where it doesn't. The social settings will make links to 
+# Twitter, etc.
+# 
+# Also, be sure to customize baseurl for your site.
+#
+# ---------------------------------------------------------------
+# 
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+title: Your awesome title
+subtitle: Your awesome subtitle
+description: >- # this means to ignore newlines until "baseurl:"
+  Write an awesome description for your new site here. You can edit this
+  line in _config.yml. It will appear in your document head meta (for
+  Google search results) and in your feed.xml site description.
+# You'll want to customize baseurl for your own site:
+baseurl: "/jekyll-theme-prologue" # the subpath of your site, e.g. /blog
+url: "" # the base hostname & protocol for your site
+
+author: Your Incredible-Name
+email: your-email@example.com
+street_address: 1234 Somewhere Road
+city: Nashville
+state: TN
+zip_code: 55555
+country: United States of America
+phone: (716) 555-5555
+
+# Social settings
+facebook_url:
+github_url:
+googleplus_url:
+instagram_url:
+linkedin_url:
+pinterest_url:
+slack_url:
+twitter_url:
+
+# Build settings
+markdown: kramdown
+
+# The following settings are NECESSARY for the Prologue theme to run:
+theme: jekyll-theme-prologue
+collections: [sections]

data/_includes/header.html

@@ -27,11 +27,11 @@
       -->
       <ul>
         {% assign sections = site.sections | where_exp: 'section','section.order >= 1' %}
-        {% unless site.sections == null %}
+        {% unless sections == null %}
           {% assign sections = sections | sort: 'order' %}
           {% for section in sections %}
-            {% assign slug = section.title | slugify | default: 'untitled' %}
             {% assign title = section.title | default: 'Untitled' %}
+            {% assign slug = section.title | slugify | default: 'untitled' %}
             {% assign icon = section.icon | default: 'fa-file' %}
             <li><a href="#{{ slug }}" id="{{ slug }}-link" class="skel-layers-ignoreHref"><span class="icon {{ icon }}">{{ title }}</span></a></li>
           {% endfor %}

data/_includes/section.html

@@ -1,6 +1,6 @@
 <section id="{{ include.id | normalize_whitespace }}" class="{{ include.class | normalize_whitespace }}">
   <div class="container">
-    {{ include.header }}
+    {{ include.heading }}
     {{ include.content }}
   </div>
 </section>

data/_layouts/home.html

@@ -15,13 +15,20 @@
 		<!-- Main -->
 		<div id="main">
 			{% assign sections = site.sections | where_exp: 'section','section.order >= 1' %}
+			
+			{% if page.permalink %}
+				<!-- This if statement enables the 404 page -->
+				{% assign sections = sections | push: page %}
+			{% endif %}
+			
 			{% unless sections == null %}
-				<!-- Sections -->
 				{% assign sections = sections | sort: 'order' %}
+				
+				<!-- Sections -->
 				{% for section in sections %}
-					
-					{% assign slug = section.title | slugify | default: 'untitled' %}
+				
 					{% assign title = section.title | default: 'Untitled' %}
+					{% assign slug = section.title | slugify | default: 'untitled' %}
 					
 					{% if section.order == 1 %}
 						{% assign class = 'shade-one cover dark' %}
@@ -32,20 +39,22 @@
 					{% endif %}
 					
 					{% if section.auto-header == 'none' %}
-						{% assign header = "" %}
+						{% assign heading = "" %}
 					{% elsif section.auto-header == null or section.auto-header == 'use-title' %}
-						{% capture header %}
+						{% capture heading %}
 							<header>
 								<h2>{{ title }}</h2>
 							</header>
 						{% endcapture %}
 					{% else %}
-						{% assign header = section.auto-header %}
+						{% capture heading %}
+							<header>
+								<h2>{{ section.auto-header }}</h2>
+							</header>
+						{% endcapture %}
 					{% endif %}
 					
-					{% assign content = section.content %}
-					
-					{% include section.html id=slug class=class header=header content=content %}
+					{% include section.html id=slug class=class heading=heading content=section.content %}
 				
 				{% endfor %}
 			

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-prologue
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - HTML5 UP
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-07 00:00:00.000000000 Z
+date: 2018-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -49,6 +49,7 @@ extra_rdoc_files: []
 files:
 - LICENSE.md
 - README.md
+- _config.yml
 - _includes/footer.html
 - _includes/head.html
 - _includes/header.html