jekyll-theme-editorial 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 467974309f904b941298d515ae1b1954215768ec5a678d55c3183f2ffd0adad2
-  data.tar.gz: 4a8fa0fd9eae9ee72c51aca902557d44f4e44efb8dcb2dc4b0bcbf1cf924f88b
+  metadata.gz: 0bfa4f15c18670ce1b6a98e57c3c4e9cc7d328556f0b509eeaf5e392b1370e6c
+  data.tar.gz: 7bbb29941b7d2877635f9c5649fc6be620c39870c636747d270b043931f4fa86
 SHA512:
-  metadata.gz: a1dcf2b8d173740a378bcb6bf6f02821469255050d6cdcd7aa88862cdd8ca0fdae0d7709817427996910009f92c2a184c3f5428959465554cc8dc072a2865b18
-  data.tar.gz: 78d81b30eb4a8ca3c107b4303c193d086889d94ce45e83efd3b71097e8c1a513ed5b3cd11243ddeea7db9553918eaf80d949a283fa963e0c01f5262de897a088
+  metadata.gz: bd69f9070261ccd67fe2419a761858cc257e781a3d7b251c5ade1e8f5cb19b544f1422faf41a1bf55f9313db2f87c5e225de820a8f89dc4fbfa4e1ef5a42e58d
+  data.tar.gz: 7b28ee9d890714636a1d2894afc617fd06d5cde420354155af9ff6212babfe5f3271675f78417a721e31060c0df75d0899a7f9c47f3f98f13c369714f0413fe9

data/README.md

@@ -1090,7 +1090,7 @@ collections:
 ```
 
 #### People page defaults
-We'll also need to add some page defaults to the `_config.yml` file for people pages, under the `defaults` key:
+We'll also need to add some page defaults to the `_config.yml` file for people pages, under the `defaults` key that we defined earlier:
 
 ```yaml
   - scope:
@@ -1193,7 +1193,75 @@ Now restart our Jekyll server since we changed our site config, and refresh the
 
 ### Add Projects
 
-TODO
+Projects are just another type of collection that are neither date-based posts nor people. You can use them for any kind of collection you'd like, visually renaming the collection to something more suitable to your purposes, even if the theme calls the collection "projects" internally. We'll largely go through the same steps as adding people.
+
+#### Set up the Projects collection
+As with the people collection, configure Jekyll in the `_config.yml` file to output our projects collection:
+
+```yaml
+###################
+# Collections
+###################
+collections:
+  people:
+    output:         true
+  pages:
+    output:         true
+  projects:                 # find/put projects in `\_projects`
+    output:         true
+```
+
+#### Project page defaults
+Let's add in the relevant page defaults to the `_config.yml` file under the `defaults` key we defined earlier:
+
+```yaml
+  - scope:
+      path:         ""
+      type:         "projects"
+    values:
+      layout:       "project"
+      menus:        'projects'                # used by jekyll-menus plugin
+      type:         "projects"
+      image_path:   "/assets/images/"
+      comments:     false
+      published:    false
+```
+#### Create some projects
+As before, nothing will have changed at this point until we add some projects. We'll again just copy them from the Editorial theme gem rather than create them from scratch. If necessary, use `bundle info` again to find the theme gem from which to copy the `_projects` folder with its 4 project files inside into your site folder:
+
+```sh
+:~/my-jekyll-site$ bundle info --path jekyll-theme-editorial
+```
+Then, after you save the `_config.yml` file, restart, and refresh the browser, you should see three new menu items under "Projects" in the menu sidebar for the added project pages (as with authors, the 4th is unpublished). By the way, now that we have some projects, we're showing their mini-post cards in the sidebar as well!
+
+
+### Add the Projects index page
+
+Similar to what we did with authors, we'll use the theme's `projects.html` include to list out standard project blocks for the projects index page. We set the page's `permalink` in the front matter to `/projects/` so that it overrides the ugly default HTML index page. If there are no published projects, we'll just show a little message stating as much. Save this file as `_pages/projects.html` (not to be confused with `_includes/projects.html` which is provided by the Editorial theme gem).
+
+```liquid
+---
+title:            Projects
+date:             2020-03-01 01:23:45 -0800
+permalink:        /projects/
+---
+
+<p>These projects are the bomb. Well, not really a bomb, but <em>da bomb</em>, y'know, like awesome but more explosive or something. Anyway check em out and make happy noises <em>en masse</em>.</p>
+
+{% include projects.html %}
+```
+Now you can click on "Projects" in the sidebar menu and hopefully see a nicely formatted list of the 3 published projects. You can toggle the `published` status of the fourth project to see that one as well.
+
+### Toggle summaries and dates for project pages
+
+Our sample project pages have extended summaries which we'd like to show. At the same time, our projects index page is displaying a page creation date that looks odd in the upper right corner of page content area. We can fix both via two site configuration settings in `_config.yml`:
+
+```yaml
+include_summary:    [projects]                # collections for which to show the summary in the header
+exclude_dates:      [people, pages]           # collections for which to not show dates in the header
+```
+Add these two lines to `_config.yml` and restart Jekyll to see the date disappear on the projects index page (which is part of the `pages` collection, not the `projects` colllection) and summaries on each of the individual published project pages (which *are* part of the `projects` collection). While we're at it, we removed publication dates from people pages too.
+
 
 ## Setup Notes
 

data/_config.yml

@@ -24,6 +24,7 @@ timezone:           America/Los_Angeles       # set this to a standardized TZ na
 date_format:                                  # optional; set the way dates are formatted throughout the site - see https://ruby-doc.org/core/Time.html#method-i-strftime
 
 
+
 ###################
 # Build settings
 ###################

data/_includes/authors_byline.html

@@ -22,7 +22,10 @@ local:
 {%-assign authors       = include.author        | default: page.author-%}
 {%-assign peeps         = site.collections      | where: "label", 'people' | first-%}
 
-{%-if site.show.post_authors and page.type=="posts"-%}
+{%-if site.show.authors and include.page_type=="index"-%}
+  {%-assign show_authors      = true-%}
+  {%-assign has_author_cards  = false-%}
+{%-elsif site.show.post_authors and page.type=="posts"-%}
   {%-assign show_authors      = true-%}
   {%-assign has_author_cards  = true-%}
 {%-elsif site.show.project_authors and page.type=="projects"-%}
@@ -49,13 +52,13 @@ local:
                 {%-assign author      = site.people | where: 'handle', slug  | first-%}
                 {%-assign author_name = author.name | default: slug-%}
                 {%-if author.published and has_author_cards %}
-                  <li><a href="#{{-author.handle-}}" class="p-author" title="Read {{ author.handle-}}'s excerpt below">{{-author_name-}}</a></li>
+                  <li><a href="#{{-author.handle-}}" class="p-author" itemprop="author" title="Read {{ author.handle-}}'s excerpt below">{{-author_name-}}</a></li>
                 {%-elsif author.published and peeps.output-%}
-                  <li><a href="{{-author.url-}}" rel="author" class="p-author u-author" title="Read {{ author.handle-}}'s bio">{{-author_name-}}</a></li>
+                  <li><a href="{{-author.url-}}" rel="author" class="p-author u-author" itemprop="author" title="Read {{ author_name | split: ' ' | first-}}'s bio">{{-author_name-}}</a></li>
                 {%-elsif author.published-%}
-                  <li class="p-author">{{-author_name-}}</li>
+                  <li class="p-author" itemprop="author">{{-author_name-}}</li>
                 {%-elsif has_author_cards %}
-                  <li><a href="#{{-slug-}}" class="p-author" title="Read {{ slug-}}'s excerpt below">{{-slug-}}</a></li>
+                  <li><a href="#{{-slug-}}" class="p-author" itemprop="author" title="Read {{ slug-}}'s excerpt below">{{-slug-}}</a></li>
                 {%-else-%}
                   <li class="p-author">{{-slug-}}</li>
                 {%-endif-%}

data/_includes/mini-posts.html

@@ -1,5 +1,5 @@
-{%-assign published_projects  = site.projects           | where: 'published', true -%}
-{%-assign project_menu        = site.data.menus.sidebar | find: 'identifier', 'projects' -%}
+{%-assign published_projects  = site.projects           | where: 'published', true-%}
+{%-assign project_menu        = site.data.menus.sidebar | find: 'identifier', 'projects'-%}
 {%-if published_projects != empty %}
           <!-- Section - Mini-posts -->
           <section>

data/_includes/project.html

@@ -0,0 +1,57 @@
+{%-comment-%}
+lists a project as a section card given a project hash
+
+inputs:
+  project                 the project to render
+dependencies:
+  site.show.authors       used to determine whether to show authors
+  site.show.project_authors used to determine whether to show authors
+  site.title              used to determine whether to show separator
+local:
+  modified_date           the proejct's modification date, if any, that differs from project.date
+{%-endcomment-%}
+
+          {%-if project.published %}
+            <article itemid="{{-project.url|absolute_url-}}" class="h-entry project-card row gtr-50 gtr-uniform" itemscope itemtype="http://schema.org/Article">
+            {% if project.images-%}
+              <div class="col-4 col-12-small">
+                <figure>
+                  <a href="{{-project.url-}}" class="image fit" title="Learn more about '{{-project.title-}}'">
+                    {% include item_image.html-%}
+                  </a>
+                </figure>
+                <div class="snug smaller categories">{%-include categories.html %}</div>
+              {%-if project.series %}
+                <div class="snug series" title="This project is part of a series">{{ project.series | replace: '-',' ' |  split: " " | join: "-----" | camelcase | split: "-----" | join: " "-}}</div>
+              {%-endif %}
+              </div>
+            {%-endif %}
+              <div class="col-8 col-12-small">
+                {%-assign modified_date = project.modified_date | default: project.last_modified_at-%}
+              {%-if modified_date-%}
+                {% include date_modified.html item_date=modified_date lead_in='last modified: '-%}
+              {%-endif %}
+                <header class="tight">
+                  <span class="header-aside">{% include item_date.html %}</span>
+                  <h3><a href="{{-project.url-}}" itemprop="name" class="u-url p-name" title="Learn more about '{{-project.title-}}'">{{-project.title-}}</a></h3>
+                  <p class="subtitle p-subtitle" itemprop="alternativeHeadline">{{-project.subtitle-}}</p>
+                  {%-if site.show.project_authors and site.show.authors and project.author or project.location-%}
+                  <div class="byline">
+                    {% include authors_byline.html page_type="index" author=project.author-%}
+                    {%-if project.location-%}
+                    {% if project.author or site.title-%}{{-" | "-}}{%-endif %}
+                    <span class="p-location" itemprop="location" title="Post location">{{-project.location-}}</span>
+                    {%-endif %}
+                  </div>
+                  {%-endif-%}
+                </header>
+                {% if include.summary or project.summary or project.excerpt-%}
+                <div class="summary p-summary" itemprop="abstract">
+                {{-include.summary | default: project.summary | default: project.excerpt | markdownify-}}
+                </div>
+                {%-endif %}
+                {%-include tags.html %}
+              </div>
+            </article>
+            <hr class="major"/>
+          {% endif %}

data/_includes/projects.html

@@ -1,88 +1,22 @@
 {%-comment-%}
 lists projects as section cards given a projects hash
 
-inputs:                   none
-dependencies:
+inputs:
   projects                the projects to render
+dependencies:
   site.projects           used as the default if `projects` isn't available already
-  site.static_files       lookup and make sure a placeholder.png file exists
-  site.show.authors       used to determine whether to show authors
-  site.show.project_authors used to determine whether to show authors
-  site.people             lookup authors in the people array
-  site.title              use as the author, as a last resort
+  page.layout             used to see if projects should be set to site.projects
 local:
   projects                default to site.projects if not already provided
   published_projects      projects filtered for `published==true`
-  placeholder             placeholder.png file to use in case no other page image is available
-  auth                    the author's handle, used for unpublished authors in place of their name
-  author                  the looked-up author in site.people
 {%-endcomment-%}
 
-{%-if page.layout == "page"-%}
-  {%-assign projects          = site.projects-%}
-{%-endif-%}
-{%-assign published_projects  = projects          | where: 'published', true-%}
+{%-if page.layout == "page"-%}{%-assign projects = site.projects-%}{%-endif-%}
+{%-assign published_projects = projects | where: 'published', true-%}
 
       {%-if published_projects != empty %}
         {%-for project in published_projects %}
-          {%-if project.published %}
-            <article itemid="{{-project.url|absolute_url-}}" class="h-entry project-card row gtr-50 gtr-uniform" itemscope itemtype="http://schema.org/Article">
-            {% if project.images-%}
-              <div class="col-4 col-12-small">
-                <figure>
-                  <a href="{{-project.url-}}" class="image fit" title="Learn more about '{{-project.title-}}'">
-                    {% include item_image.html-%}
-                  </a>
-                </figure>
-                <div class="snug smaller categories">{%-include categories.html %}</div>
-              {%-if project.series %}
-                <div class="snug series" title="This project is part of a series">{{ project.series | replace: '-',' ' |  split: " " | join: "-----" | camelcase | split: "-----" | join: " "-}}</div>
-              {%-endif %}
-              </div>
-            {%-endif %}
-              <div class="col-8 col-12-small">
-                {%-assign modified_date = project.modified_date | default: project.last_modified_at-%}
-              {%-if modified_date-%}
-                {% include date_modified.html item_date=modified_date lead_in='last modified: '-%}
-              {%-endif %}
-                <header class="tight">
-                  <span class="header-aside">{% include item_date.html %}</span>
-                  <h3><a href="{{-project.url-}}" itemprop="name" class="u-url p-name" title="Learn more about '{{-project.title-}}'">{{-project.title-}}</a></h3>
-                  <p class="subtitle p-subtitle" itemprop="alternativeHeadline">{{-project.subtitle-}}</p>
-                  {%-if site.show.project_authors and site.show.authors and project.author or project.location-%}
-                  <p class="byline">
-                  {%-if site.show.authors %}
-                    {%-for auth in project.author-%}
-                      {%-assign author = site.people | find: 'handle', auth-%}
-                      {%-if author.published and author.url-%}
-                        <a href="{{-author.url-}}" rel="author" itemprop="author" class="u-author p-author" title="Read {{ author.name | split: ' ' | first-}}'s bio">{{-author.name-}}</a>
-                      {%-elsif author.published-%}
-                        <span itemprop="author" class="p-author">{{-author.name-}}</span>
-                      {%-else-%}
-                        <span itemprop="author" class="p-author">{{-auth-}}</span>
-                      {%-endif-%}
-                      {%-unless forloop.last %}, {% endunless-%}
-                    {%-else-%}
-                      <span itemprop="author" class="p-author">{{-site.title-}}</span>
-                    {%-endfor-%}
-                    {%-if project.location and project.author or site.title-%}{{-"&nbsp; | &nbsp;"-}}{%-endif-%}
-                  {%-endif %}
-                    {%-if project.location %}
-                    <span class="p-location" itemprop="location" title="Post location">{{-project.location-}}</span>
-                    {%-endif %}
-                  </p>
-                  {%-endif-%}
-                </header>
-                {% if include.summary or project.summary or project.excerpt-%}
-                <div class="summary p-summary" itemprop="abstract">
-                {{-include.summary | default: project.summary | default: project.excerpt | markdownify-}}
-                </div>
-                {%-endif %}
-                {%-include tags.html %}
-              </div>
-            </article>
-            <hr class="major"/>
-          {% endif %}
+          {% include project.html %}
         {% endfor %}
       {% else %}
             <h2>Oof!</h2>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-editorial
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Middle Bear
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -143,6 +143,7 @@ files:
 - _includes/post_header.html
 - _includes/post_nav.html
 - _includes/posts.html
+- _includes/project.html
 - _includes/projects.html
 - _includes/responsive_banner.html
 - _includes/scripts.html