steve-for-jekyll 1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c51e855c1fb3004217431097199681e09854d74c217f9ef853ea18cd8e1a468b
-  data.tar.gz: 745845b405d92e8fed26ee0a31fcf2d8b3f4ea150c4572e838c37bd84b786478
+  metadata.gz: 8d48b46874b23563736072e38066c55729738dbd29edd7dc0481bcf507497fe1
+  data.tar.gz: ba010c4c5054f45c8d00f5c6c65c01d751ef0b69c488c636b097bcfdb1afa27b
 SHA512:
-  metadata.gz: 166223275238afedf0f4b9a1e195793df2cf020549325122cef3968029bda8aa8617ea75e331266202b8fd03a478a021e1ccc786083276fcd9a9b07c36e68938
-  data.tar.gz: 1df804482f3eadb8ca485cecfd4d7d7cd67f9da9bfd7636c7c92986842ba3495755a67ff8962828eed153a099eb12da5bc48f0f0ee20ec677eb5954019a6dfd0
+  metadata.gz: c344c0f6c86e74443d634f5db2636c3a237b54d586b2c87b84c704fc65b53d177f84de24a24fa9c5c5071b618f2957df25cfe9e7db021e30447f476113c2007e
+  data.tar.gz: 442425b0f96ad3f7a597be65b69427133c9584447ddf0b73f292074193607203fd6f929977f5bce0b2836e5bce116670f47c3622b339b26349322a3f43566e42

data/404.html

@@ -0,0 +1,9 @@
+---
+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

@@ -73,12 +73,14 @@ You can change Steve's appearance with a different color scheme or typography se
 
 1. Create a `screen.scss` file in `assets/css`.
 2. Add the following content:
-    ```scss
-    ---
-    ---
 
-    @import "{{ site.theme }}";
-    ```
+   ```scss
+   ---
+   ---
+
+   @import "{{ site.theme }}";
+   ```
+
 3. Before the `@import` declaration, you can set the following custom SCSS variables:
 
 ```scss
@@ -105,12 +107,11 @@ $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.
+$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.
@@ -123,16 +124,16 @@ Steve supports two editable areas and three different menus.
 
 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.
+- 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` — The main menu, above the website content.
-* `_data/social.yml` — The social menu, in the website sidebar.
-* `_data/links.yml` — And a third menu at the bottom of your website's footer.
+- `_data/menu.yml` — The main menu, above the website content.
+- `_data/social.yml` — The social menu, in the website sidebar.
+- `_data/links.yml` — 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:
 
@@ -151,12 +152,12 @@ Blogrolls are linked lists shown in your site's sidebar.Like menus, you can set
 ```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: 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
@@ -165,7 +166,7 @@ Blogrolls are linked lists shown in your site's sidebar.Like menus, you can set
       url: "https://example.net"
     - title: Link 3
       url: "https://example.org"
-``` 
+```
 
 ### Plugin-specific settings
 
@@ -179,6 +180,46 @@ Steve uses the following Jekyll plugins to create sitemaps, RSS feeds, archives
 
 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
+```
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/esporo/steve>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
@@ -190,9 +231,8 @@ To set up your environment to develop this theme, run `bundle install`.
 Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
 
 When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
-To add a custom directory to your theme-gem, please edit the regexp in `steve.gemspec` accordingly.
+To add a custom directory to your theme-gem, please edit the regexp in `steve-for-jekyll.gemspec` accordingly.
 
 ## License
 
 The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-

data/_config.yml

@@ -1,70 +1,96 @@
-# Site info
-title: Steve for Jekyll
-tagline: Charming and fun blog theme.
-description: Steve is a charming and fun blog theme for Jekyll websites.
-
-email: steve-support@esporo.net
-
-lang: en
-
-url: "https://esporo.github.io/steve"
-baseurl: ""
-
-# Theme settings
-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"
-    archives:
-      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:
-    next_page: "&laquo; Next"
-    prev_page: "Previous &raquo;"
-    prev_post: "Previous:"
-    next_post: "Next:"
-  post:
-    byline: "By"
-    tags: More about…
-  search:
-    label: Search this blog
-    placeholder: What you're looking for?
-    submit: Go!
-
-
-# Build settings
-markdown: kramdown
-permalink: "/:year/:month/:day/:title/"
-
-theme: steve-for-jekyll
-
-paginate: 6
-paginate_path: "/page/:num/"
-
-plugins:
-  - jekyll-feed
-  - jekyll-seo-tag
-  - jekyll-sitemap
-  - jekyll-paginate
-  - jekyll-archives
-
-# Plugin: jekyll-archives
-jekyll-archives:
-  enabled: all
-  layout: archive
-  slug_mode: default
-  permalinks:
-    day: "/:year/:month/:day/"
-    month: "/:year/:month/"
-    year: "/:year/"
-    category: "/:name/"
-    tag: "/tag/:name/"
+# Site info
+title: Steve for Jekyll
+tagline: Charming and fun blog theme.
+description: Steve is a charming and fun blog theme for Jekyll websites.
+
+email: steve-support@esporo.net
+
+lang: en
+
+url: ""
+baseurl: "/steve/"
+
+# Theme settings
+steve:
+  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"
+    archives:
+      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:
+    next_page: "&laquo; Next"
+    prev_page: "Previous &raquo;"
+    prev_post: "Previous:"
+    next_post: "Next:"
+  post:
+    byline: "By"
+    tags: More about…
+  search:
+    label: Search this blog
+    placeholder: What you're looking for?
+    submit: Go!
+
+# Comments Settings
+comments:
+  title: Comments
+  form_title: New Comment
+  date_format: "%b %e, %Y @ %l:%M %P"
+  staticman_endpoint: # Get yours on <https://staticman.net>
+  notice: |+
+    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
+
+
+# Build settings
+markdown: kramdown
+permalink: "/:year/:month/:day/:title/"
+
+theme: steve-for-jekyll
+
+paginate: 6
+paginate_path: "/page/:num/"
+
+plugins:
+  - jekyll-feed
+  - jekyll-seo-tag
+  - jekyll-sitemap
+  - jekyll-paginate
+  - jekyll-archives
+
+# Plugin: jekyll-archives
+jekyll-archives:
+  enabled: all
+  layout: archive
+  slug_mode: default
+  permalinks:
+    day: "/:year/:month/:day/"
+    month: "/:year/:month/"
+    year: "/:year/"
+    category: "/:name/"
+    tag: "/tag/:name/"

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/post.html

@@ -1,13 +1,27 @@
 <article class="content post">
   <header class="content-header">
+    {% if post.category %}
+      <div class="content-meta">
+        {%- assign category_slug = post.category | slugify -%}
+        {%- assign category_url = site.jekyll-archives.permalinks.category -%}
+
+        <a
+          href="{{ category_url | replace: ':name', category_slug | relative_url }}"
+          rel="tag"
+        >
+          {{- post.category -}}
+        </a>
+      </div>
+    {% endif %}
+
     {% if post.title != "" %}
       <h2 class="content-title">
-        <a href="{{ post.url }}" rel="bookmark">{{ post.title }}</a>
+        <a href="{{ post.url | relative_url }}" rel="bookmark">{{ post.title }}</a>
       </h2>
     {% endif %}
 
     <div class="content-meta">
-      <a class="content-date" href="{{ post.url }}" rel="bookmark">
+      <a class="content-date" href="{{ post.url | relative_url }}" rel="bookmark">
         <time datetime="{{ post.date | date_to_xmlschema }}">
           {{ post.date | date: site.steve.date_formats.post }}
         </time>

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 %}