steve-for-jekyll 1.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c837ff93e1e9855f712da1f580559ef04530333c4c63e9a3bb37042c6d8cee4
-  data.tar.gz: 66c3123e4f2e17afb3b89527c5aa7660e36e7061f957b1d362277634b944f7c8
+  metadata.gz: a389c90db2e3b245518de6435f252af866364407c443d230dfb86650b973c080
+  data.tar.gz: 14d3da3cde1ab5f98dcaeac45902130ac2c3a8c72f46fc6ead1a1b9206506a4d
 SHA512:
-  metadata.gz: d0e4cb6d03cd8f10500dd0b154e5887d122bfd191c738f9831e9b2f74c0d0cd90729fe68bc623c15d7ca5f3be559c2f099e26e395cd7d05d80929e5788e5c3fd
-  data.tar.gz: 8d74ce76512ce06fbe249c2b09d793ae1617de1068c35d8fe4290ac6e8c831c0a6e498d39ab20d15b997b27e6f5f2999e9eaf15b4ed37d3a9cec0fe0943fcff7
+  metadata.gz: 75c4d5035590b6ab7d5a8d9f7ff4dab748d1e3c07529cca8d4f3b62433e6a5e822e4c5f95d5c6f3869b832f9fd36ac1919e912b6a7a7442684297aeca0d1bfce
+  data.tar.gz: a8d8815a88553274381f432e1c40bbb3bf68179615bdb757e499bae6ac02a062aca96fac4f7138125885e218c2200d4702f8808f3527ef4618d5d6b840b0cf05

data/404.html

@@ -1,9 +1,9 @@
----
-layout: page
-title: 404
-permalink: /404.html
----
-
-{{ site.steve.page_404 | markdownify }}
-
-{% include search-form.html %}
+---
+layout: page
+title: 404
+permalink: /404.html
+---
+
+{{ site.steve.page_404 | markdownify }}
+
+{% include search-form.html %}

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2021 Arthur Freitas
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2021 Arthur Freitas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -26,201 +26,7 @@ Or install it yourself as:
 
     $ gem install steve
 
-## Usage
-
-Steve is made to be used with zero-configuration needed. Even so, you can customize it further with theme settings, style variables, content includes and plugin-specific configurations. We will guide you through each one of those.
-
-### Theme settings
-
-Steve's settings are defined in your site's `_config.yml`:
-
-```yaml
-steve:
-  intensedebate_account: # get one at <https://intensedebate.com/install>
-  archives: # Prefixes used with archive titles
-    date: Posts from
-    tag: More about…
-    category: Posts filed in
-  date_formats: # Uses <http://strftime.net>
-    post: "%b %e, %Y" # The date format used in the post layout.
-    archives: # The date formats for the archive layout.
-      day: "%b %e, %Y"
-      month: "%b, %Y"
-      year: "%Y"
-  page_404: |+
-    The page you're looking for could not be found.
-
-    Maybe the search can help.
-  pagination: # Strings used in the blog- and post-pagination.
-    next_page: "&laquo; Next"
-    prev_page: "Previous &raquo;"
-    prev_post: "Previous:"
-    next_post: "Next:"
-  post: # Strings used in the post layout.
-    byline: "By"
-    tags: More about…
-  search: # Strings used in the search form.
-    label: Search this blog
-    placeholder: What you're looking for?
-    submit: Go!
-```
-
-The above are the default values that Steve will use. Feel free to change the ones you want. This is useful if you want to localize the theme strings or change the date formats used by the theme.
-
-### Style variables
-
-You can change Steve's appearance with a different color scheme or typography setting custom variables. Follow these instructions:
-
-1. Create a `screen.scss` file in `assets/css`.
-2. Add the following content:
-
-   ```scss
-   ---
-   ---
-
-   @import "{{ site.theme }}";
-   ```
-
-3. Before the `@import` declaration, you can set the following custom SCSS variables:
-
-```scss
-/*
-  Color Scheme
-*/
-
-$color__background-content: #fff; // posts, pages and sidebar background color.
-$color__background-body: #e4f0f6; // body background color:
-$color__text: #000112; // body text color
-
-$color__link: #4e9dd8; // color for links and accents
-$color__link-hover: #2361a7; // alternate color for active or focused links and accents
-
-$color__details: #939496; // color for details such as borders and shadows
-$color__details-lighter: #f0f1f4; // lighter alternative for details
-$color__details-darker: #6d6e70; // darker alternative for details
-
-/*
-  Typography
-*/
-
-$font__body: sans-serif; // used for the main, body typography
-$font__headings: sans-serif; // used for headings and feature elements
-$font__code: monospace; // used for pre-formatted text and code.
-
-/*
-  Layout
-*/
-$layout__container-width: 1180px; // the width of the main content (content + sidebar)
-$layout__gutter: 2rem; // the spacing unit between elements.
-```
-
-You can change the values to any variable you want. Steve will replace the default values set by the theme with the ones you choose. Be sure that the variable definitions are **above** your `@import "{{ site.theme }}"` declaration.
-
-### Content includes
-
-Steve supports two editable areas and three different menus.
-
-#### Editable areas
-
-You can add any content you want in your site's sidebar or footer.
-
-- Create a `custom-widgets.html` file in `_includes/blog/` to add custom content to your site's sidebar.
-- Create a `custom-text.html` file in `_includes/footer` to add custom content to your site's footer.
-
-#### Menus
-
-Steve has three menu positions controlled using [Jekyll data files](https://jekyllrb.com/docs/datafiles/):
-
-- `_data/menu.yml` &mdash; The main menu, above the website content.
-- `_data/social.yml` &mdash; The social menu, in the website sidebar.
-- `_data/links.yml` &mdash; And a third menu at the bottom of your website's footer.
-
-Create the respective data file for the menu you want to use. Menus are a YAML List with the following structure:
-
-```yaml
-- title: "About this site" # The item title
-  url: "/about/" # The item URL or path
-  external: true # Optional, if the link points to an external resource.
-  color: "#336699" # Only on `_data/menu.yml`, the background color of this menu item.
-  icon: "<svg ...>" # Only on `_data/social.yml`, the SVG icon markup for this item -- get one in <https://simpleicons.org>
-```
-
-#### Blogrolls
-
-Blogrolls are linked lists shown in your site's sidebar.Like menus, you can set up as any blogrolls as you want using the `_data/blogroll.yml` data file.
-
-```yaml
-- title: Blogroll # The blogroll title shown in the sidebar
-  links: # The list of links in this blogroll
-    - title: Link 1
-      url: "https://example.com"
-    - title: Link 2
-      url: "https://example.net"
-    - title: Link 3
-      url: "https://example.org"
-- title: Blogroll 2
-  links:
-    - title: Link 1
-      url: "https://example.com"
-    - title: Link 2
-      url: "https://example.net"
-    - title: Link 3
-      url: "https://example.org"
-```
-
-### Plugin-specific settings
-
-Steve uses the following Jekyll plugins to create sitemaps, RSS feeds, archives and much more.
-
-- [jekyll-feed](https://github.com/jekyll/jekyll-feed) &mdash; generates the RSS feed.
-- [jekyll-seo-map](https://github.com/jekyll/jekyll-seo-tag) &mdash; generates site's OpenGraph and SEO meta tags.
-- [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap) &mdash; generates the XML sitemap.
-- [jekyll-paginate](https://github.com/jekyll/jekyll-paginate) &mdash; paginates the home post list.
-- [jekyll-archives](https://github.com/jekyll/jekyll-archives) &mdash; generates the archives by date, tag and category.
-- [jekyll-loading-lazy](https://github.com/gildesmarais/jekyll-loading-lazy) &mdash; adds `loading="lazy"` to all images and frames on your pages and posts.
-
-While Steve sets initial configurations for these plugins, you may want to change them in your `_config.yml`. Please refer to these plugins documentations for further reading about how to change their config options.
-
-### Comments
-
-Steve supports [Staticman](https://staticman.net)-powered comments, and provides initial settings from our own `staticman.yml` config file. You can create your own settings at any time, but keep in mind that Steve looks for the following fields when submitting comments:
-
-- `name`
-- `email`
-- `website`
-- `message`
-
-[Follow these instructions](https://staticman.net/docs/getting-started.html) to set up your Staticman instance.
-
-You can also customize your comments' section and submit form adding the `site.comments` object in your `_config.yml`:
-
-```yaml
-comments:
-  title: Comments
-  form_title: New Comment
-  date_format: "%b %e, %Y @ %l:%M %P"
-  staticman_endpoint: # Get yours on <https://staticman.net>
-  notice: |+ # Accepts Markdown
-    Please be nice in the comments.
-
-    Comments are moderated, so it can take a while for your's to show up.
-
-    Also, you can use [Markdown](https://daringfireball.net/projects/markdown).
-  fields:
-    name:
-      label: Name
-      placeholder: "John Appleseed"
-    email:
-      label: Email address
-      placeholder: "your@email.net"
-    website:
-      label: Website
-      placeholder: "https://john.blog/"
-    message:
-      label: Message
-      placeholder: Your comment message
-    submit: Submit Comment
-```
+Steve will work out-of-the-box when installed, but it has plenty of options for you to make it yours. [Refer to the theme documentation](https://github.com/esporo/steve/wiki) to learn how to add menus, comments, change your theme style or set up Steve's options.
 
 ## Contributing
 

data/_includes/blog/custom-widgets.html

@@ -1,3 +1,3 @@
-{% comment %}
-  Add your custom sidebar widgets here!
-{% endcomment %}
+{% comment %}
+  Add your custom sidebar widgets here!
+{% endcomment %}

data/_includes/blog/sidebar.html

@@ -1,42 +1,42 @@
-{% include search-form.html class="widget -search" %}
-
-{% capture custom_widgets %}
-  {% include blog/custom-widgets.html %}
-{% endcapture %}
-
-{% assign custom_widgets = custom_widgets | strip | strip_newlines | normalize_whitespace %}
-
-{% if site.data.social or site.data.blogroll or custom_widgets != "" %}
-  <aside class="widget -sidebar">
-    {% if site.data.social %}
-      <ul class="social-links">
-        {% for link in site.data.social %}
-          <li class="link">
-            <a href="{{ link.url }}" rel="external">
-              {{ link.icon }}
-            </a>
-          </li>
-        {% endfor %}
-      </ul>
-    {% endif %}
-    {% if site.data.blogroll %}
-      {% for blogroll in site.data.blogroll %}
-        <section class="blogroll">
-          <h4 class="blogroll-title">{{ blogroll.title }}</h4>
-
-          <ul class="blogroll-list">
-            {% for link in blogroll.links %}
-              <li class="link">
-                <a href="{{ link.url }}" {% if link.external %} rel="external" {% endif %}>
-                  {{ link.title }}
-                </a>
-              </li>
-            {% endfor %}
-          </ul>
-        </section>
-      {% endfor %}
-    {% endif %}
-
-    {{ custom_widgets }}
-  </aside>
-{% endif %}
+{% include search-form.html class="widget -search" %}
+
+{% capture custom_widgets %}
+  {% include blog/custom-widgets.html %}
+{% endcapture %}
+
+{% assign custom_widgets = custom_widgets | strip | strip_newlines | normalize_whitespace %}
+
+{% if site.data.social or site.data.blogroll or custom_widgets != "" %}
+  <aside class="widget -sidebar">
+    {% if site.data.social %}
+      <ul class="social-links">
+        {% for link in site.data.social %}
+          <li class="link">
+            <a href="{{ link.url }}" rel="external">
+              {{ link.icon }}
+            </a>
+          </li>
+        {% endfor %}
+      </ul>
+    {% endif %}
+    {% if site.data.blogroll %}
+      {% for blogroll in site.data.blogroll %}
+        <section class="blogroll">
+          <h4 class="blogroll-title">{{ blogroll.title }}</h4>
+
+          <ul class="blogroll-list">
+            {% for link in blogroll.links %}
+              <li class="link">
+                <a href="{{ link.url }}" {% if link.external %} rel="external" {% endif %}>
+                  {{ link.title }}
+                </a>
+              </li>
+            {% endfor %}
+          </ul>
+        </section>
+      {% endfor %}
+    {% endif %}
+
+    {{ custom_widgets }}
+  </aside>
+{% endif %}

data/_includes/footer/custom-text.html

@@ -1,5 +1,5 @@
-{% comment %}
-  Create a file like this and add your own custom content that should be shown at the bottom of your website.
-{% endcomment %}
-
-{{ site.description }}
+{% comment %}
+  Create a file like this and add your own custom content that should be shown at the bottom of your website.
+{% endcomment %}
+
+{{ site.description }}

data/_includes/footer.html

@@ -1,11 +1,11 @@
-<footer class="colophon">
-  <div class="site-info">
-    <h5>
-      <a href="{{ site.url }}">{{ site.title }}</a>
-    </h5>
-
-    {% include footer/custom-text.html %}
-  </div>
-
-  {% include footer/links.html %}
-</footer>
+<footer class="colophon">
+  <div class="site-info">
+    <h5>
+      <a href="{{ site.url }}">{{ site.title }}</a>
+    </h5>
+
+    {% include footer/custom-text.html %}
+  </div>
+
+  {% include footer/links.html %}
+</footer>

data/_includes/head.html

@@ -2,15 +2,7 @@
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>
-    {%- if page.title -%}
-      {{ page.title }} ({{ site.title }})
-    {%- else -%}
-      {{ site.title }} - {{ site.tagline }}
-    {%- endif -%}
-  </title>
-
-  {% seo title=false %}
+  {% seo %}
 
   <link rel="stylesheet" href="{{ '/assets/css/screen.css' | relative_url }}" />
   {% feed_meta %}

data/_includes/header/menu.html

@@ -1,12 +1,12 @@
-{% if site.data.menu %}
-  <nav class="site-menu">
-    {% for item in site.data.menu %}
-      <a class="menu-item" href="{{ item.url }}"
-        {% if item.external %} rel="external" {% endif %}
-        {% if item.color %} style="background-color: {{ item.color }}" {% endif %}
-      >
-        {{ item.title }}
-      </a>
-    {% endfor %}
-  </nav>
-{% endif %}
+{% if site.data.menu %}
+  <nav class="site-menu">
+    {% for item in site.data.menu %}
+      <a class="menu-item" href="{{ item.url }}"
+        {% if item.external %} rel="external" {% endif %}
+        {% if item.color %} style="background-color: {{ item.color }}" {% endif %}
+      >
+        {{ item.title }}
+      </a>
+    {% endfor %}
+  </nav>
+{% endif %}

data/_includes/header.html

@@ -1,17 +1,17 @@
-{% capture site_branding %}
-<a href="{{ "/" | relative_url }}">
-  {% if site.logo %}
-    <img class="logo" src="{{ site.logo }}" alt="{{ site.title }}" />
-  {% else %}
-    {{ site.title }}
-  {% endif %}
-</a>
-{% endcapture %}
-
-<header class="masthead">
-  {% if page.title %}
-    <p class="site-title">{{ site_branding }}</p>
-  {% else %}
-    <h1 class="site-title">{{ site_branding }}</h1>
-  {% endif %} {% include header/menu.html %}
-</header>
+{% capture site_branding %}
+<a href="{{ "/" | relative_url }}">
+  {% if site.logo %}
+    <img class="logo" src="{{ site.logo }}" alt="{{ site.title }}" />
+  {% else %}
+    {{ site.title }}
+  {% endif %}
+</a>
+{% endcapture %}
+
+<header class="masthead">
+  {% if page.title %}
+    <p class="site-title">{{ site_branding }}</p>
+  {% else %}
+    <h1 class="site-title">{{ site_branding }}</h1>
+  {% endif %} {% include header/menu.html %}
+</header>

data/_includes/search-form.html

@@ -1,13 +1,13 @@
-<form action="//duckduckgo.com" method="get" {% if include.class %}class="{{ include.class }}"{% endif %}>
-  <label for="search_terms">{{ site.steve.search.label }}</label>
-
-  <div class="search-controls">
-
-    <input id="search_terms" placeholder="{{ site.steve.search.placeholder }}" type="search" name="q" required />
-    <input type="hidden" name="sites" value="{{ site.url | remove: 'https://' }}" />
-    <button type="submit">
-      {{ site.steve.search.submit }}
-    </button>
-
-  </div>
-</form>
+<form action="//duckduckgo.com" method="get" {% if include.class %}class="{{ include.class }}"{% endif %}>
+  <label for="search_terms">{{ site.steve.search.label }}</label>
+
+  <div class="search-controls">
+
+    <input id="search_terms" placeholder="{{ site.steve.search.placeholder }}" type="search" name="q" required />
+    <input type="hidden" name="sites" value="{{ site.url | remove: 'https://' }}" />
+    <button type="submit">
+      {{ site.steve.search.submit }}
+    </button>
+
+  </div>
+</form>

data/_layouts/archive.html

@@ -1,21 +1,21 @@
----
-layout: blog
----
-
-<header class="archive-header">
-  {% if page.date %}
-    <h1>
-      {{ site.steve.archives.date }}<br />
-      <strong>{{ page.date | date: site.steve.date_formats.archives[page.type] }}</strong>
-    </h1>
-  {% else %}
-    <h1>
-      {{ site.steve.archives[page.type] }}<br />
-      <strong>{{ page.title }}</strong>
-    </h1>
-  {% endif %}
-</header>
-
-{% for post in page.posts %}
-  {% include blog/post.html full_post=false %}
-{% endfor %}
+---
+layout: blog
+---
+
+<header class="archive-header">
+  {% if page.date %}
+    <h1>
+      {{ site.steve.archives.date }}<br />
+      <strong>{{ page.date | date: site.steve.date_formats.archives[page.type] }}</strong>
+    </h1>
+  {% else %}
+    <h1>
+      {{ site.steve.archives[page.type] }}<br />
+      <strong>{{ page.title }}</strong>
+    </h1>
+  {% endif %}
+</header>
+
+{% for post in page.posts %}
+  {% include blog/post.html full_post=false %}
+{% endfor %}

data/_layouts/default.html

@@ -1,18 +1,18 @@
-<!doctype html>
-<html lang="{{ page.lang | default: site.lang }}">
-  {% include head.html %}
-
-  <body class="{{ page.layout | prepend: 'layout-' }}">
-    {% include header.html %}
-
-    <main class="container">
-      {{ content }}
-    </main>
-
-    {% include footer.html %}
-
-    {% if content contains "iframe" %}
-      <script src="{% link assets/js/responsive-videos.js %}"></script>
-    {% endif %}
-  </body>
-</html>
+<!doctype html>
+<html lang="{{ page.lang | default: site.lang }}">
+  {% include head.html %}
+
+  <body class="{{ page.layout | prepend: 'layout-' }}">
+    {% include header.html %}
+
+    <main class="container">
+      {{ content }}
+    </main>
+
+    {% include footer.html %}
+
+    {% if content contains "iframe" %}
+      <script src="{% link assets/js/responsive-videos.js %}"></script>
+    {% endif %}
+  </body>
+</html>

data/_layouts/home.html

@@ -1,23 +1,23 @@
----
-layout: blog
----
-
-{% for post in paginator.posts %}
-  {% include blog/post.html %}
-{% endfor %}
-
-{% if paginator.total_pages > 1 %}
-  <nav class="content-navigation">
-    {% if paginator.previous_page %}
-      <a class="nav-link prev-link" href="{{ paginator.previous_page_path | relative_url }}" rel="prev">
-        {{ site.steve.pagination.next_page }}
-      </a>
-    {% endif %}
-
-    {% if paginator.next_page %}
-      <a class="nav-link next-link" href="{{ paginator.next_page_path | relative_url }}" rel="next">
-        {{ site.steve.pagination.prev_page }}
-      </a>
-    {% endif %}
-  </nav>
-{% endif %}
+---
+layout: blog
+---
+
+{% for post in paginator.posts %}
+  {% include blog/post.html %}
+{% endfor %}
+
+{% if paginator.total_pages > 1 %}
+  <nav class="content-navigation">
+    {% if paginator.previous_page %}
+      <a class="nav-link prev-link" href="{{ paginator.previous_page_path | relative_url }}" rel="prev">
+        {{ site.steve.pagination.next_page }}
+      </a>
+    {% endif %}
+
+    {% if paginator.next_page %}
+      <a class="nav-link next-link" href="{{ paginator.next_page_path | relative_url }}" rel="next">
+        {{ site.steve.pagination.prev_page }}
+      </a>
+    {% endif %}
+  </nav>
+{% endif %}