jekyll-theme-editorial 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef624ce7299a555c4e432222097806162ceeea393841fa2f089fe72b04a5e064
-  data.tar.gz: e77a0b84dfc0f110f8b34635a18c2a0ffb06132ed16dc5b4d4ea05e32426fc6d
+  metadata.gz: c17e4e3729eec2d2187e99bc67b2a2b69490f2376d86c124b4f096e47072c7c4
+  data.tar.gz: ff2b0c32c2943d1a7a3046dea4df53603d0d9d22a1257fa8b3be3bc074f72eb9
 SHA512:
-  metadata.gz: '089687bfb0c4d45d9863811bf5d0d2fe1be3483e3086643df04154e8cf279ed427dfe9c11168fdb3a225bda9f9ecf1e4b7612c47050ed5f04528914e1ebb73be'
-  data.tar.gz: 28cffcf0a3a3f6b4a3d85e815021eb755b697bd1fcb4acda136af770b0c9987a44c101203cff8c397accb2457cf75307d9e65cca7bfd794e4c099507b67cd254
+  metadata.gz: 4ccdef2cba4a660e42097ad8d49c8c44a2f6eb53f9a3fc635103a3833461f410fb175c48e434b39758d9ca8f8cf68717c09ebb11a8d4720f6b1f15b0bbc93a55
+  data.tar.gz: db0167399c786ab02e3222311c6d3f40959c05789c441f1f093ef9d576a9efa82cb7e07fcbd1c8b16f6ec2fd36f26127675dc91db74d9ec21004d0679a240adb

data/README.md

@@ -25,7 +25,7 @@ Here are some basic principles I attempted to adhere to:
 
 Note that `:~$` is the shell prompt, so copy and paste the bits *after* that (and the 2 lines in the middle represent the `jekyll` command's output):
 
-```
+```sh
 :~$ jekyll new my-jekyll-site
 ... a bunch of output from Jekyll ...
 New jekyll site installed in ~/my-jekyll-site.
@@ -36,7 +36,7 @@ This will create the basic structure of your Jekyll site with all the default fi
 
 You can then run it to see the default site in your browser (`:~/my-jekyll-site$` is the shell prompt, so don't copy that part):
 
-```
+```sh
 :~/my-jekyll-site$ bundle exec jekyll serve
 ```
 
@@ -56,12 +56,14 @@ theme: jekyll-theme-editorial
 
 And then to download and make it available to your site, execute:
 
-    :~/my-jekyll-site$ bundle
-
+```sh
+:~/my-jekyll-site$ bundle
+```
 Or directly install it yourself as:
 
-    :~/my-jekyll-site$ gem install jekyll-theme-editorial
-
+```sh
+:~/my-jekyll-site$ gem install jekyll-theme-editorial
+```
 Then run `bundle exec jekyll serve` (or the shorter `jekyll s` if your setup allows) to see the site so far.
 
 Unless you already had content likes posts and an index file, you'll be staring at largely a blank page, along with a collapsible left menu sidebar and site header, at this point. That's ok, move on to the next section!
@@ -119,10 +121,55 @@ This adds three includes (`responsive_banner.html`, `features.html`, and `articl
 
 This index page is the root page of your site by default, and uses the special `home` layout from the theme. The `home` layout is generally only used by this index page, so that your homepage can have a unique feel and design. If you wish to change this layout, copy the file `_layouts/home.html` from the theme gem (or copy/download it from the Github repository for the theme gem) to your site's `~/my-jekyll-site/_layouts/home.html` file.
 
+#### Aside: Finding the theme gem
+
+It's sometimes difficult to find the theme gem on your system, especially if you're using a version manager, such as [RVM](https://rvm.io "Ruby Version Manager"), along with [bundler](https://bundler.io/ "Rubygems Bundler") for managing gems. Here's the handy incantation `bundle info --path` for finding the directory where a particular gem is installed (assuming it was installed using bundler):
+
+```sh
+:~/my-jekyll-site$ bundle info --path jekyll-theme-editorial
+~/.rvm/rubies/ruby-2.7.1/lib/ruby/gems/2.7.0/gems/jekyll-theme-editorial-1.0.2
+```
+You can then copy the path and `cd` into it:
+
+```sh
+:~/my-jekyll-site$ cd ~/.rvm/rubies/ruby-2.7.1/lib/ruby/gems/2.7.0/gems/jekyll-theme-editorial-1.0.2
+:~/.rvm/rubies/ruby-2.7.1/lib/ruby/gems/2.7.0/gems/jekyll-theme-editorial-1.0.2$
+```
+
+or, at least on macOS, you can directly `open` the gem directory in Finder with:
+
+```sh
+:~/my-jekyll-site$ open ~/.rvm/rubies/ruby-2.7.1/lib/ruby/gems/2.7.0/gems/jekyll-theme-editorial-1.0.2
+```
+There, you can copy any file from the gem and place it into the corresponding folder of your site to make modifications and enhancements to any part of the theme that you wish.
+
+#### Viewing the site index page
+
 At this point, you may also want to change the name of this file from `index.markdown` to the shorter and more conventional `index.md`.
 
 Assuming you left `jekyll serve` running, efresh your browser (on `http://localhost:4000/`) to see the changes so far. You should see a banner with an image, an empty Features section, and an Articles section with one post, "Welcome to Jekyll!".
 
+#### Add asset paths to site configuration
+
+Since its 4.0 release, Jekyll has supported theme configuration defaults by including a `_config.yml` file in the theme gem. This support doesn't yet seem to be universal however. If you're working in an environment that doesn't yet support config defaults being pulled from the theme's gem (like Github pages, which currently uses Jekyll v3.8.7), you'll need to directly add site asset paths to your `_config.yml`:
+
+```yaml
+###################
+# Theme settings
+###################
+image_path:         '/assets/images/'         # site-wide default path for images
+script_path:        '/assets/js/'             # site-wide default path for scripts
+style_path:         '/assets/css/'            # site-wide default path for styles
+scripts:                                      # these scripts entries can be moved to `_data/scripts.yml` for cleaner and more dynamic script inclusion
+  - file: jquery.min.js
+  - file: browser.min.js
+  - file: breakpoints.min.js
+  - file: util.js
+  - file: main.js
+  - file: email-obfuscation.js
+  - file: comments.js
+```
+
 #### Change the site title/subtitle
 
 The title and subtitle of the site is configured by the site's `_config.yml` file, since this is usually a one-time configuration at the start of creating your site. Find this line in `_config.yml`:
@@ -139,7 +186,7 @@ subtitle: by me and Middlebear
 
 As the default introductory comments in `_config.yml` note, you have to restart the jekyll server for site configuration changes (changes to this file only) to be applied. First, quit the running jekyll server by pressing `ctrl-c`, and restart it again with the same command (or `bundle exec jekyll serve` if necessary):
 
-```
+```sh
 :~/my-jekyll-site$ jekyll s
 ```
 Refresh your browser page (on `http://localhost:4000/`) to see the changes you made at the top of the page in the site header area.
@@ -828,6 +875,9 @@ permalink:        /posts/     # trailing slash makes it an `index.html` file ins
 We also need to tell Jekyll to output collection pages, so add the `collections` key to `_config.yml`:
 
 ```yaml
+###################
+# Collections
+###################
 collections:
   pages:
     output:         true
@@ -1023,7 +1073,92 @@ jekyll-archives:
 
 ### Add People
 
-TODO
+Sone sites will have multiple people associated with it, as authors or otherwise, so let's add a people collection to our site.
+
+#### Set up the People collection
+First, let's tell Jekyll, in our `_config.yml` file, to output our new people collection to individual pages:
+
+```yaml
+###################
+# Collections
+###################
+collections:
+  people:                   # find/put people in `\_people`
+    output:         true
+  pages:
+    output:         true
+```
+
+#### People page defaults
+We'll also need to add some page defaults to the `_config.yml` file for people pages, under the `defaults` key:
+
+```yaml
+  - scope:
+      path:         ""
+      type:         "people"
+    values:
+      layout:       "author"
+      menus:        'authors'                 # used by jekyll-menus plugin
+      type:         "people"
+      image_path:   "/assets/images/"
+      author_bio:   "<p>We're still working on a fabulous author bio and page. Check back later to learn more!</p>"
+      comments:     false
+      published:    true
+```
+
+#### Create some people
+At this point, nothing on the site will have changed. Now we need to add a person or two. Being lazy bears, instead of creating these pages from scratch, we'll just copy them from the Editorial theme gem. As a refresher, to find the theme gem, use
+
+```sh
+:~/my-jekyll-site$ bundle info --path jekyll-theme-editorial
+```
+From the Editorial theme gem directory, we'll copy the whole `_people` directory, which includes 4 people files, to our own site directory. Directories that begin with an underscore ('_') are special to Jekyll. In this case, it houses our people collection.
+
+#### Turn show authors back on (if turned off before)
+For the `authors` key under the `show` key in `_config.yml`, replace `false` with `true`:
+
+```yaml
+show:                                         # series of switches to customize what appears on the site
+  authors:          true                      # single author blogs may want to disable showing the same author everywhere
+```
+Restart the Jekyll server and click on the "People" link (which now has 3 sub-items too!) in the sidebar menu. Oops... you'll see an unstyled HTML listing page. We'll fix that next. In the meantime, you should be able to click on the three people listed to see their author pages. Why 3 and not 4? Because one of them is not yet published.
+
+### Add the Authors index page
+
+To provide a nice list of authors, we'll take advantage of the theme's `author.html` include, which provides a standard block list format for an author. We iterate through our `site.people` and generate this include for each published author. We set the pages `permalink` in the front matter to `/people/` so that it overrides the ugly HTML index page we saw earlier. Incidentally, if `site.show.authors` is set to `false`, then we'll just show a "404 Not Found" page instead.
+
+
+```liquid
+---
+title:            Authors
+date:             2020-01-02 01:23:45 -0800
+author_bio:       "<p>We're still working on this bio!</p>"
+permalink:        /people/    # trailing slash makes it an `index.html` file inside the `/people/` directory, rather than a `people.html` file in the root
+---
+
+{% if site.show.authors-%}
+  {% assign peeps = site.collections | find: "label", 'people'-%}
+  {% if peeps.output-%}
+    <p>Our wonderful authors love to share tales of wonder and zeal. Sometimes they go overboard and fall into the waters of silliness or cynicism. We hope you do understand, and take that into the highest consideration.</p>
+    <hr class="major"/>
+    {% if site.show.authors %}
+      {% for author in site.people %}
+        {%-if author.published %}
+          {% include author.html %}
+        {%-else-%}
+          {% include author.html excerpt=page.author_bio %}
+        {%-endif %}
+        <hr class="major"/>
+      {% endfor %}
+    {% endif %}
+  {% endif %}
+{%-else-%}
+  {% include 404.html %}
+{%-endif-%}
+```
+If all went well, you should be able to refresh the ugly people index listing and get a nicely formatted one in its place.
+
+### Add Authors to our lone post
 
 ### Add Projects
 

data/_config.yml

@@ -283,14 +283,14 @@ jekyll-archives:
 # Jekyll SEO Tag  - https://github.com/jekyll/jekyll-seo-tag
 ###################
 twitter:
-  username:         jekyllrb  # This site's Twitter handle
+  username:         middlebear2 # This site's Twitter handle
   card:             summary   # This site's default card type
-facebook:
-  app_id:           1239284   # Facebook app ID for Facebook insights
-  publisher:        1232529   # Facebook page URL or ID of the publishing entity
-  admins:           1236093   # Facebook user ID for domain insights linked to a personal account
+# facebook:
+#   app_id:           1239284   # Facebook app ID for Facebook insights
+#   publisher:        1232529   # Facebook page URL or ID of the publishing entity
+#   admins:           1236093   # Facebook user ID for domain insights linked to a personal account
 social:                       # use `_data/social.yml` to configure visible links to social media
-  name:             "Your Name"
+  name:             "Middle Bear"
   links:
     - https://twitter.com/middlebear2
     - https://gravatar.com/middlebear2
@@ -298,9 +298,9 @@ social:                       # use `_data/social.yml` to configure visible link
     - https://rubygems.org/profiles/middlebear
     - https://twitter.com/jekyllrb
     - https://github.com/jekyll
-webmaster_verifications:
-  google:           UA-1234-1
-  bing:             1234
-  alexa:            1234
-  yandex:           1234
-  baidu:            1234
+# webmaster_verifications:
+#   google:           UA-1234-1
+#   bing:             1234
+#   alexa:            1234
+#   yandex:           1234
+#   baidu:            1234

data/_includes/item_image.html

@@ -10,12 +10,13 @@ local:
   image                   the image to render as the article image
   alt_text                the alt text to use for the image, for screen readers
   img_title               the image title to use for the image
+NOTE: github doesn't like the `find` filter - change to `where` for now
 {%-endcomment-%}
 
 {%-assign item        = article | default: post | default: project | default: pg | default: page-%}
-{%-assign placeholder       = site.static_files         | find: 'name', 'placeholder.png'-%}
+{%-assign placeholder       = site.static_files         | where: 'name', 'placeholder.png'-%}
 {%-assign static_file_names = site.static_files         | map: 'name'-%}
-{%-assign image       = item.images.thumbnail.file      | default: item.images.default.file     | default: item.images.banner.file      | default: item.thumbnail       | default: item.image     | default: item.banner | default: placeholder.name-%}
+{%-assign image       = item.images.thumbnail.file      | default: item.images.default.file     | default: item.images.banner.file      | default: item.thumbnail       | default: item.image     | default: item.banner | default: placeholder.first.name-%}
 {%-assign alt_text    = item.images.thumbnail.alt_text  | default: item.images.default.alt_text | default: item.images.banner.alt_text  | default: item.images.alt_text | default: item.alt_text  | default: item.banner.alt_text-%}
 {%-assign img_title   = item.images.thumbnail.title     | default: item.images.default.title    | default: item.images.banner.title     | default: item.images.title    | default: item.title     | default: item.banner.title-%}
 
@@ -23,7 +24,7 @@ local:
           {%-if static_file_names contains image %}
           <img src="{{-item.image_path | default: site.image_path-}}{{-image-}}" itemprop="thumbnail" class="u-photo" title="{{-img_title-}}" alt="{{-alt_text-}}"/>
           {%-elsif image == empty %}
-          <img src="{{-item.image_path | default: site.image_path-}}{{-placeholder.name-}}" title="{{-img_title-}}" alt="{{-alt_text-}}"/>
+          <img src="{{-item.image_path | default: site.image_path-}}{{-placeholder.first.name-}}" title="{{-img_title-}}" alt="{{-alt_text-}}"/>
           {%-else %}
           <div class="box"><h3>Missing image</h3>{{-image-}}<br>{{-img_title-}}</div>
           {%-endif %}

data/_pages/people.html

@@ -5,9 +5,9 @@ author_bio:       "<p>We're still working on this bio!</p>"
 permalink:        /people/    # trailing slash makes it an `index.html` file inside the `/people/` directory, rather than a `people.html` file in the root
 ---
 
-{% if site.show.authors -%}
-  {% assign peeps = site.collections | find: "label", 'people' -%}
-  {% if peeps.output -%}
+{% if site.show.authors-%}
+  {% assign peeps = site.collections | find: "label", 'people'-%}
+  {% if peeps.output-%}
     <p>Our wonderful authors love to share tales of wonder and zeal. Sometimes they go overboard and fall into the waters of silliness or cynicism. We hope you do understand, and take that into the highest consideration.</p>
     <hr class="major"/>
     {% if site.show.authors %}

data/index.md

@@ -4,11 +4,11 @@ layout:               home
 body_class:           home
 title:                "Hi, I’m Editorial<br /> by HTML5 UP & Middle Bear"
 subtitle:             # overrides `site.tagline`, the default
-description:          "Aenean ornare velit lacus, ac varius enim ullamcorper eu. Proin aliquam facilisis ante interdum congue. Integer mollis, nisl amet convallis, porttitor magna ullamcorper, amet egestas mauris. Ut magna finibus nisi nec lacinia. Nam maximus erat id euismod egestas. Pellentesque sapien ac quam. Lorem ipsum dolor sit nullam."
+description:          "Check out the Github repo for the Editorial theme, or take a look at the code for the demo site, <a href='https://github.com/jekyll-theme-editorial/jekyll-theme-editorial.github.io/'>jekyll-theme-editorial.github.io</a>."
 banner:
-  url:                "/about"
-  link_title:         "Read About Editorial"
-  button_text:        "Learn More"
+  url:                "https://github.com/middlebear/jekyll-theme-editorial"
+  link_title:         "Visit the Editorial theme Github repo"
+  button_text:        "Github Repo"
 images:
   banner:
     file:             "pic10.jpg"

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-editorial
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Middle Bear
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-02 00:00:00.000000000 Z
+date: 2020-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.7
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.7
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: jekyll-feed
   requirement: !ruby/object:Gem::Requirement