jekyll-theme-prologue 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +18 -15
- data/_config.yml +2 -2
- data/_includes/footer.html +2 -2
- data/_sass/jekyll-theme-prologue.scss +13 -0
- metadata +4 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4f4d8a8ce832fc9a79e98c7643565ad1d962e568
|
|
4
|
+
data.tar.gz: c223475d7386347af192d6a6d610e0375f81bc4e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b79392fc0a3435b2ba612477ddd472547574e12fca4462ff4c2b4f238a158d749a49b4bb7ddc66314ce10f120f5892a025171f8d299ff02824f5deea926cb1d6
|
|
7
|
+
data.tar.gz: f74ba5b64cf794e7ebf4f069d9ba2cd758cbaeda69ed56826321b4d2c608b4dfe0c654c5ab3fc4d1114f9a55656b5eab66a38036f3bdbb34df207353d1ec0a76
|
data/README.md
CHANGED
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
# Prologue - Jekyll Theme
|
|
2
2
|
|
|
3
|
-
(Actively maintained, expect some changes.)
|
|
4
|
-
|
|
5
3
|
[](https://badge.fury.io/rb/jekyll-theme-prologue)
|
|
6
4
|
|
|
7
5
|
|
|
@@ -12,21 +10,22 @@ This is Prologue, a simple, single page responsive site template from [HTML5 UP]
|
|
|
12
10
|
|
|
13
11
|
# Added Features
|
|
14
12
|
|
|
15
|
-
*
|
|
13
|
+
* **Blogging and multi-page features you expect from Jekyll**
|
|
14
|
+
* Compatible with GitHub Pages
|
|
16
15
|
* **[Formspree.io](https://formspree.io/) contact form integration** - just add your email to the `_config.yml` and it works!
|
|
17
|
-
* Build your homepage with custom scrolly sections in the _sections folder
|
|
18
|
-
* Set a cover photo for any section (not just the first), with alt text for screen readers and SEO
|
|
16
|
+
* Build your homepage with **custom scrolly sections** in the _sections folder
|
|
17
|
+
* Set a **cover photo** for any section (not just the first), with alt text for screen readers and SEO
|
|
19
18
|
* Add your **social profiles** easily in `_config.yml`.
|
|
20
|
-
*
|
|
21
|
-
* Google Analytics built-in; just put your [Tracking ID](https://support.google.com/analytics/answer/1008080?hl=en) in `_config.yml` as `google_analytics`
|
|
22
|
-
* Custom 404 page (called 404.html; to activate, move it to your project directory).
|
|
19
|
+
* Automatic search engine optimization (SEO) **meta tags** based on info you provide in `_config.yml` and frontmatter
|
|
20
|
+
* **Google Analytics** built-in; just put your [Tracking ID](https://support.google.com/analytics/answer/1008080?hl=en) in `_config.yml` as `google_analytics`
|
|
21
|
+
* Custom **404 page** (called 404.html; to activate, move it to your project directory).
|
|
23
22
|
|
|
24
23
|
# Installation
|
|
25
24
|
|
|
26
25
|
There are two ways to get started (choose one):
|
|
27
26
|
|
|
28
27
|
1. **Install the [jekyll-theme-prologue gem](https://rubygems.org/gems/jekyll-theme-prologue).** Instructions are in the [Jekyll docs](https://jekyllrb.com/docs/themes/#installing-a-theme). After running `bundle install`, you can find the theme files by running `open $(bundle show jekyll-theme-prologue)`. A sample working `_config.yml` file ships with the gem; if you want to activate it, move it to your project's root directory. It will do nothing until you move it there, replacing the default `_config.yml` file.
|
|
29
|
-
2. **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`, and replace `theme: jekyll-theme-prologue` with `remote_theme: chrisbobbe/jekyll-theme-prologue` in the provided `_config.yml` ([GitHub Pages now supports open-source themes on GitHub](https://github.com/blog/2464-use-any-theme-with-github-pages)).
|
|
28
|
+
2. **Fork or clone 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`, and replace `theme: jekyll-theme-prologue` with `remote_theme: chrisbobbe/jekyll-theme-prologue` in the provided `_config.yml` ([GitHub Pages now supports open-source themes on GitHub](https://github.com/blog/2464-use-any-theme-with-github-pages)).
|
|
30
29
|
|
|
31
30
|
Next, make sure that `url` and `base_url` are set for your own website in `_config.yml`. For local testing, make them both blank. Add a photo avatar to your project, then set `avatar: path/to/your/avatar.jpg` in _config.yml; for example, `avatar: assets/images/avatar.jpg` (48x48 pixels works best). Poke around the sample `_config.yml` file to see how you can add your social profiles.
|
|
32
31
|
|
|
@@ -34,7 +33,7 @@ Next, make sure that `url` and `base_url` are set for your own website in `_conf
|
|
|
34
33
|
|
|
35
34
|
1. **Your `_config.yml` file must include the following line or your homepage won't work**: `collections: [sections]`. This tells Jekyll to look in the _sections folder (which you will create) for your content and render it all on one page.
|
|
36
35
|
|
|
37
|
-
2. **Create a `_sections` folder** in your project's root directory and start adding content to your homepage. Set a cover photo in any of the sections by adding `cover-photo: path/to/photo.jpg` and `cover-photo-alt: your alt text here` to the section's frontmatter. Sample content is provided in the [GitHub repository](https://github.com/chrisbobbe/jekyll-theme-prologue/tree/master/_sections).
|
|
36
|
+
2. **Create a `_sections` folder** in your project's root directory and start adding content to your homepage. Set a cover photo in any of the sections by adding `cover-photo: path/to/photo.jpg` and `cover-photo-alt: your alt text here` to the section's frontmatter. Sample content is provided in the [GitHub repository](https://github.com/chrisbobbe/jekyll-theme-prologue/tree/master/_sections).
|
|
38
37
|
|
|
39
38
|
All new sections should be added as html or Markdown documents in the `_sections` folder. The following section variables can be set with [frontmatter](https://jekyllrb.com/docs/frontmatter/):
|
|
40
39
|
- `title` (required)
|
|
@@ -45,7 +44,7 @@ All new sections should be added as html or Markdown documents in the `_sections
|
|
|
45
44
|
- `auto-header` (optional; "use-title" is default, "none" for no header, or custom header text)
|
|
46
45
|
- `hide` (optional; if `true`, the section won't appear)
|
|
47
46
|
|
|
48
|
-
# Start blogging!
|
|
47
|
+
# Start blogging!
|
|
49
48
|
|
|
50
49
|
Jekyll has great resources to get you started writing blog posts. Check out [this Jekyll Docs page](https://jekyllrb.com/docs/posts/) first. When you've written a post or two, copy the following into a new file in your project directory called `blog.html`, and you'll see a link to your blog from the homepage:
|
|
51
50
|
|
|
@@ -60,12 +59,12 @@ title: My Blog
|
|
|
60
59
|
|
|
61
60
|
# Add a page
|
|
62
61
|
|
|
63
|
-
To add a page, just make a new .html or .
|
|
62
|
+
To add a page, just make a new .html or .md file in your project directory. There's an example called `reading-list` [provided](https://github.com/chrisbobbe/jekyll-theme-prologue/blob/master/reading-list.md) with the GitHub repository. Add this frontmatter:
|
|
64
63
|
|
|
65
64
|
```
|
|
66
65
|
---
|
|
67
|
-
title: My New Page
|
|
68
|
-
layout: page
|
|
66
|
+
title: My New Page
|
|
67
|
+
layout: page
|
|
69
68
|
---
|
|
70
69
|
```
|
|
71
70
|
|
|
@@ -75,10 +74,14 @@ You can also set these page variables in the frontmatter, if you want:
|
|
|
75
74
|
- `icon` (optional; see [Font Awesome](http://fontawesome.io/icons/) for icon codes. Example: `fa-github`)
|
|
76
75
|
- `hide` (optional; if `true`, a link won't appear in the nav menu. All this does is remove the nav link; your page will still be served to anyone who has the URL.)
|
|
77
76
|
|
|
78
|
-
**This same set of frontmatter variables can also be
|
|
77
|
+
**This same set of frontmatter variables (including `title`) can also be set in `index.md` and `blog.html`.** You may want to give them titles, or hide the homepage link with `hide: true` if the homepage is the only page.
|
|
79
78
|
|
|
80
79
|
For advanced SEO, this theme also lets you add `permalink` (see [Jekyll Docs](https://jekyllrb.com/docs/permalinks/#where-to-configure-permalinks)), `robots` (string, e.g. "noindex, nofollow"), and `canonical` (boolean; true is default) to any page or post.
|
|
81
80
|
|
|
81
|
+
# Contributing
|
|
82
|
+
|
|
83
|
+
Please feel free to submit issues and feature requests!
|
|
84
|
+
|
|
82
85
|
# Credits
|
|
83
86
|
|
|
84
87
|
Thanks to @andrewbanchich for his many Jekyll adaptations of HTML5 UP's elegant themes, which helped and inspired me, and of course many thanks to HTML5 UP.
|
data/_config.yml
CHANGED
|
@@ -39,9 +39,9 @@ author: Your Incredible Name
|
|
|
39
39
|
email: your-email@example.com
|
|
40
40
|
avatar: assets/images/avatar.jpg
|
|
41
41
|
|
|
42
|
-
# You'll want to customize baseurl for your own site:
|
|
42
|
+
# You'll want to customize url and baseurl for your own site:
|
|
43
43
|
baseurl: "/jekyll-theme-prologue" # the subpath of your site, e.g. /blog
|
|
44
|
-
url: "
|
|
44
|
+
url: "" # the base hostname & protocol for your site
|
|
45
45
|
|
|
46
46
|
# Social settings
|
|
47
47
|
facebook_url:
|
data/_includes/footer.html
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
|
|
4
4
|
<!-- Copyright -->
|
|
5
5
|
<ul class="copyright">
|
|
6
|
-
{
|
|
6
|
+
{% if site.title or site.author %}
|
|
7
7
|
<li>© {{- site.title | default: site.author -}}. All rights reserved.</li>
|
|
8
|
-
{
|
|
8
|
+
{% endif %}
|
|
9
9
|
<li>Design: <a href="http://html5up.net">HTML5 UP</a></li>
|
|
10
10
|
<li>Jekyll integration: <a href="https://chrisbobbe.github.io/">Chris Bobbe</a></li>
|
|
11
11
|
</ul>
|
|
@@ -221,6 +221,14 @@
|
|
|
221
221
|
margin-bottom: 0;
|
|
222
222
|
}
|
|
223
223
|
|
|
224
|
+
.row {
|
|
225
|
+
margin-top: 40px;
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
.row > * {
|
|
229
|
+
padding-top: 0;
|
|
230
|
+
}
|
|
231
|
+
|
|
224
232
|
ul, ol {
|
|
225
233
|
padding-left: 0.25em;
|
|
226
234
|
margin-left: 1.25em;
|
|
@@ -648,6 +656,11 @@
|
|
|
648
656
|
}
|
|
649
657
|
> article {
|
|
650
658
|
text-align: left;
|
|
659
|
+
header {
|
|
660
|
+
p {
|
|
661
|
+
font-style: italic;
|
|
662
|
+
}
|
|
663
|
+
}
|
|
651
664
|
}
|
|
652
665
|
> section, article {
|
|
653
666
|
margin: 0;
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-theme-prologue
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.3.
|
|
4
|
+
version: 0.3.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- HTML5 UP
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2018-01-
|
|
12
|
+
date: 2018-01-15 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: jekyll
|
|
@@ -39,8 +39,7 @@ dependencies:
|
|
|
39
39
|
- - "~>"
|
|
40
40
|
- !ruby/object:Gem::Version
|
|
41
41
|
version: '1.12'
|
|
42
|
-
description: 'A Jekyll version of the
|
|
43
|
-
Demo: https://chrisbobbe.github.io/jekyll-theme-prologue/'
|
|
42
|
+
description: 'A Jekyll version of the Prologue theme by HTML5 UP. Demo: https://chrisbobbe.github.io/jekyll-theme-prologue/'
|
|
44
43
|
email:
|
|
45
44
|
- csbobbe@gmail.com
|
|
46
45
|
executables: []
|
|
@@ -123,5 +122,5 @@ rubyforge_project:
|
|
|
123
122
|
rubygems_version: 2.6.14
|
|
124
123
|
signing_key:
|
|
125
124
|
specification_version: 4
|
|
126
|
-
summary: A Jekyll version of the
|
|
125
|
+
summary: A Jekyll version of the Prologue theme by HTML5 UP.
|
|
127
126
|
test_files: []
|