steve-for-jekyll 0.1.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e0a6795be07f919339de32014015774dfbd98eeae72ad145367cbf13fa5c09a
-  data.tar.gz: 702e15208e6fc94b085708341143a030f1e8c949a34b3fbf48be887c807023cf
+  metadata.gz: 30db961533c03e5fc57450d2c60ed9bfb0eb0fb2db2458fe18d1feb6bfd6c7d9
+  data.tar.gz: 8a5ca288b685b1615a4a81533d3133529053230375d423df62c5c39465b3f4ea
 SHA512:
-  metadata.gz: 43cbee9aca3fb27a80cad6bff413099ca4008131e7093983099e4b26f575772458f00f8c2b91dbef4069ee5cc092deca7f23edc5fc76350552ca3f4daae144eb
-  data.tar.gz: 86ae5c43da11e9d2c0d7a5dc3a2431f6c4ceccc6edb6fea4f5ef072c7b8b7268e7928e60883a9d78ade0231a14ca83c5e1325f8308848c6678af57a175ff4d32
+  metadata.gz: 8eb77604f98315bccef6cc7a5ed5ebcceebfdcb247d95ff252dabc317a6cbcd11b79b3715de976ac728962835360a34eef889a57d0706a42219eec80152bf2b5
+  data.tar.gz: 9e72a82ba9e616b20310c69748bf61b173caeed4fa856fb87a2bae4c39ee8f4bef6f46c27744a472242676ded7205352561bea9fe8117d0b557a37217b4e46b2

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

@@ -1,6 +1,6 @@
 # Steve for Jekyll
 
-Steve is a charming and fun blog theme for [Jekyll](https://jekyllrb.com/), the static site generator. It's developed by [@arthrfrts](https://github.com/arthrfrts) to be used on the [Esporo](https://esporo.net/) website.
+Steve is a charming and fun blog theme for [Jekyll](https://jekyllrb.com/), the static site generator. It's developed by [@arthrfrts](https://github.com/arthrfrts) to be used on the [Esporo](https://esporo.net/) websites — but feel free to use it in any project you may find it fitting.
 
 See it in action on the [demo site](https://esporo.github.io/steve).
 
@@ -28,11 +28,161 @@ Or install it yourself as:
 
 ## Usage
 
-### 1. Install dependencies
+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.
+
+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.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. 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.
+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.
 
 ## Development
 
@@ -41,9 +191,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,51 +1,70 @@
-# 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"
-baseurl: ""
-
-# Theme settings
-steve:
-  intensedebate_account: # get one at <https://intensedebate.com/install>
-  archive_title:
-    date: "Posts from"
-    tag: "More about"
-    category: "Category:"
-  date_formats:
-    archive:
-      day: "%m/%d/%Y"
-      month: "%m/%Y"
-      year: "%Y"
-    post: "%m/%d/%Y"
-
-# Build settings
-markdown: kramdown
-permalink: "/:year/:month/:day/:title/"
-
-paginate: 2
-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:
+  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/"

data/_includes/blog/custom-widgets.html

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

data/_includes/blog/post.html

@@ -1,47 +1,43 @@
-{% assign lang = page.lang | default: site.lang %}
-
-{% assign locale = site.data.locales[lang] %}
-
-<article class="content post">
-  <header class="content-header">
-    {% if post.title != "" %}
-      <h2 class="content-title">
-        <a href="{{ post.url }}" rel="bookmark">{{ post.title }}</a>
-      </h2>
-    {% endif %}
-
-    <div class="content-meta">
-      <a class="content-date" href="{{ post.url }}" rel="bookmark">
-        <time datetime="{{ post.date | date_to_xmlschema }}">
-          {{ post.date | date: locale.date_formats.post }}
-        </time>
-      </a>
-
-      {% if post.author %}
-        {% assign author = site.data.authors[post.author] %}
-
-        {% if author.url %}
-          <a class="content-author" href="{{ author.url }}" rel="author">
-            {{ author.name }}
-          </a>
-        {% else %}
-          <a class="content-author" href="{{ site.twitter.username | append: 'https://twitter.com/' }}" rel="author">
-            {{ post.author }}
-          </a>
-        {% endif %}
-      {% endif %}
-    </div>
-  </header>
-
-  {% if post.image %}
-    <figure class="content-cover">
-      <img src="{{ post.image.url | default: post.image }}" alt="{{ post.image.alt | default: '' }}" />
-    </figure>
-  {% endif %}
-
-  {% unless include.full_post == false %}
-    <div class="content-body">
-      {{ post.content }}
-    </div>
-  {% endunless %}
-</article>
+<article class="content post">
+  <header class="content-header">
+    {% if post.title != "" %}
+      <h2 class="content-title">
+        <a href="{{ post.url | relative_url }}" rel="bookmark">{{ post.title }}</a>
+      </h2>
+    {% endif %}
+
+    <div class="content-meta">
+      <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>
+      </a>
+
+      {% if post.author %}
+        {% assign author = site.data.authors[post.author] %}
+
+        {% if author.url %}
+          <a class="content-author" href="{{ author.url }}" rel="author">
+            {{ author.name }}
+          </a>
+        {% else %}
+          <a class="content-author" href="{{ post.author | prepend: 'https://twitter.com/' }}" rel="author">
+            {{ post.author }}
+          </a>
+        {% endif %}
+      {% endif %}
+    </div>
+  </header>
+
+  {% if post.image %}
+    <figure class="content-cover">
+      <img src="{{ post.image.url | default: post.image }}" alt="{{ post.image.alt | default: '' }}" />
+    </figure>
+  {% endif %}
+
+  {% unless include.full_post == false %}
+    <div class="content-body">
+      {{ post.content }}
+    </div>
+  {% endunless %}
+</article>