jekyll-theme-simplex 0.9.2 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20d4911b78605ef916527f0e628dec8da5ac56cc89d3a5ce7f8ca6abd05dbe81
-  data.tar.gz: aacc42d2226b5b07520e4b2bc6b26f40ec5743882b7102473f5bd3418707dfc3
+  metadata.gz: 1251d5010926fa8ab805effd541c8e71dbbcac4a1ccfa269c6b6135a8cf5c385
+  data.tar.gz: cfd4c10677d13731ee0613356daf35086dbac9e0c850d3882be9f6c60a03c880
 SHA512:
-  metadata.gz: 98c0b72bbe1b57418cedb5788e35f7de089c777caf454a35c185bef44b3992583c094059df3662fc75d1d679798ce8365a282cdc3e4f108d671f0537173123ac
-  data.tar.gz: a98b1e4066d42a214885838db9cb195820b43b4c851907cc0254acbe23bef190bd138daee6cb101b69448dbba0a4bb41b8fb1fd315d98992bcd403afbc4ea264
+  metadata.gz: f08231a46883310d187e14de416fc8977361512d339ddae28d8885758c061cc58c00619d2d7ca815c3cd973844ce79b6e8c0db65f902bddba374a27f4d432ec4
+  data.tar.gz: 7ea776e9e5bf9f0e179c4b391f7b9a04994b07f4aaff967fa93a4e8082ca6afb6d3567d6e35cece214266fb5c3508d3ad2fb4e52c01a0182510e8653036c53b0

data/README.md

@@ -1,10 +1,27 @@
-![GitHub](https://img.shields.io/github/license/andreondra/jekyll-theme-simplex?style=flat-square)
+⚠ WORK IN PROGRESS - DO NOT USE IN PRODUCTION ⚠
+
 [![Demo](https://img.shields.io/badge/demo-golasblog-blue?style=flat-square)](https://golas.blog/)
 
 # <img src="assets/img/icons/simplex_logo.svg" alt="Simplex" height="50"/>
 
 A *simple* yet neat blogging theme. Developed for the [golas blog](https://golas.blog/) project.
 
+## 👓 Preview
+![Preview](preview.gif)
+
+## 💎 Features
+### Responsive
+![Responsivity preview](previewResponsive.gif)
+
+### Dark mode
+![Dark mode preview](previewDark.gif)
+
+### Buttons
+![Buttons preview](previewButtons.png)
+
+### Lity Lightbox 
+Supports images, videos, iFrames and more. See below for syntax.
+
 ## ℹ Installation
 
 Add this line to your Jekyll site's `Gemfile`:
@@ -29,10 +46,170 @@ Or install it yourself as:
 
 ## ✔ Usage
 
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+### ⚙ Setting up the template
+Replace the contents of the _config.yml file with the following:
+```yaml
+title: the Simplex theme #The name of your blog.
+logo_img: /assets/img/icons/golasblog_logo.svg #Absolute path to the logo. If not specified, the title will be displayed instead.
+description: description #Description.
+global_tags: jekyll theme simplex golasblog responsive html5 #Tags.
+copyright: © Golasowski 2020 #Your copyright.
+
+collections:
+    category:
+        output: true
+    authors:
+        output: false
+
+defaults:
+  -
+    scope:
+      path: ""
+      type: category
+    values:
+      layout: "category"
+```
 
-## 🤝 Contributing
+### ✨ Defining categories
+Create a `_category` folder in the root directory of the blog. Create a `.md` file for every category with the contents:
+```
+---
+category: [design] #Category ID.
+hue: var(--c-themeHueOrange) #Category hue. See note [1].
+title: Design #Category title.
+description: Lorem ipsum dolor sit amet.
+---
+```
+
+### 🤵 Defining authors
+Create a `_authors` folder in the root directory. Create a `.md` file for every author with the contents:
+```
+---
+nick: golas #Author's nick.
+full_name: Andrew Golasowski #Author's full name.
+photo_dir: assets/img/authors/golas.png #Path to the author's pic.
+---
+```
+
+### 📰 Defining the menu
+Create a `_data` folder in the root directory. In the folder, create a `nav.yaml` file. Here's an example:
+```yaml
+- title: Programming #Menu item title.
+  url: category/programming.html #Menu item url.
+  icon: assets/img/icons/programming.svg #Menu item icon.
+  hue: "var(--c-themeHueRed)" #Menu item hue - see note [1].
+  subnav: #Subnav. See note [2].
+      - title: C++ #Submenu item title.
+        url: cpp.html #Submenu item url.
+        hue: "var(--c-themeHueOrange)" #Submenu item hue.
+        subnav: #Another subnav
+            - title: Libraries
+              url: libs.html
+              hue: "var(--c-themeHueBlue)"
+- title: Design
+  url: design.html
+  icon: assets/img/icons/design.svg
+  hue: "var(--c-themeHueRed)"
+```
+#### Pro tip:
+Use color icons with the same hue as the menu items. Icons will be black and on hover the color will be shown.
+
+### ✒ Creating posts
+Posts are created in the `_posts` directory. Following front matter attributes are supported:
+```
+---
+layout: post #Do not change.
+category: [programming, testing] #One, more categories or no at all.
+title: "Lorem ipsum" #Article title.
+author: andy #Author's nick.
+---
+Your markdown content here.
+```
+
+### ⚡ Syntax highlighting
+The theme uses Pygments CSS created by [@richleland](https://github.com/richleland). If you want to modify the highlighting styles, just download different CSS or create your own - see [Jekyll docs](https://jekyllrb.com/docs/liquid/tags/#stylesheets-for-syntax-highlighting).
 
+Note - `@media` is used to manage different styles for light and dark web browser mode. See `_variables.scss` file for details.
+
+### 📷 Inserting pictures
+Classic Markdown syntax is supported. However, to be able to use the lightbox feature, you have to use HTML syntax. Minimal example:
+```html
+<a href="/assets/example.jpg" data-lity>
+  <img src="/assets/example_thumbnail.jpg"/>
+</a>
+```
+
+To provide image description use this syntax:
+```html
+<div class="sx-picture">
+  <a href="/assets/example.jpg" data-lity>
+    <img src="/assets/example_thumbnail.jpg"/>
+  </a>
+  <span class="sx-subtitle">My picture description.</span>
+</div>
+```
+
+**Do not forget the `data-lity` attribute.**
+
+#### ↔ Centering
+To center pictures, put the code inside a `div` with `sx-center` class like this:
+```html
+<div markdown=1 class="sx-center">
+  ![My picture](/assets/example.jpg)
+</div>
+```
+
+### 🔘 Buttons
+Buttons can be inserted with the following syntax. Just replace `theme` with `red`, `green`, `blue`, `orange`, `purple` or `brown`, specify the target link in `href` attribute and the icon in `src` attribute.
+```html
+<div class='sx-button'>
+  <a href='https://your.link.here.example.com/' class='sx-button__content theme'>
+    <img src='/assets/img/icons/example_icon.svg'/>#{text}
+  </a>
+</div>
+```
+
+Markdown attribute can be omitted if you don't use markdown inside the block (e.g. by using the lightbox syntax).
+
+### ℹ Notes
+[1] Hue can be either one of the predefined colors or any of the CSS `color` attribute supported values (hex, rgb...).
+
+[2] Submenus are generated recursively, so any menu (and submenu) can have its own submenu.
+
+#### Predefined colors
+You can use following predefined colors:
+```scss
+--c-themePrimaryLight: #EFEFEF;
+--c-themePrimaryDark:  #101010;
+--c-themeSecondaryLight: #DADADA;
+--c-themeSecondaryDark: #252525;
+--c-themeTerniaryLight: #AEAEAE;
+--c-themeTerniaryDark: #515151;
+--c-themeQuaternaryLight: #919191;
+--c-themeQuaternaryDark: #888888;
+
+--c-themeHueRed: #C02717;
+--c-themeHueGreen: #8EA604;
+--c-themeHueBlue: #2E86AB;
+--c-themeHueOrange: #E59500;
+--c-themeHuePurple: #9F00CE;
+--c-themeHueBrown: #230007;
+```
+These colors are CSS variables, usage: `var(--var-name)`
+
+## Add-ons
+Add-ons are distributed as Jekyll plugins. Just download any desired `.rb` file from the repository `_plugin` folder and put it in your `_plugin` folder.
+
+### Buttons (button.rb)
+Adds a tag to simplify insertion of buttons:
+```
+{% button red|https://www.example.com/|/assets/img/icons/cog.svg %}
+Download binary
+{% endbutton %}
+```
+
+## 🤝 Contributing
+ 
 Bug reports and pull requests are welcome on [GitHub](https://github.com/andreondra/jekyll-theme-simplex).
 
 ## ⚙ Development
@@ -44,7 +221,13 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun
 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 `jekyll-theme-simplex.gemspec` accordingly.
 
-## ⚖ License
+## Credits
+Includes icons by [uxwing](https://uxwing.com/).
+
+The lightbox feature is provided by [Lity](https://github.com/jsor/lity) licensed under the [MIT License](https://opensource.org/licenses/MIT).
 
-The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Uses [jQuery](https://github.com/jquery/jquery) JavaScript plugin licensed under the [MIT License](https://opensource.org/licenses/MIT).
+
+## ⚖ License
+© Ondrej Golasowski. The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 

data/_includes/head.html

@@ -1,5 +1,6 @@
 <link rel="stylesheet" href="{{ site.url }}/assets/fonts/fonts.css"/>
 <link rel="stylesheet" href="{{ site.url }}/assets/style.css"/>
+<link rel="stylesheet" href="{{ site.url }}/assets/js/lity.min.css"/>
 
 <meta charset="UTF-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">

data/_includes/header.html

@@ -1,6 +1,13 @@
 <header class="header">
     <section class="logo">
-        <h1>golasblog</h1>
+        <a href="{{ site.url }}/" class="logo__link">
+            {% if site.logo_img != nil %}
+                <h1 style="display: none;">golasblog</h1>
+                <img class="logo__link__img" src={{site.logo_img}}/>
+            {% else %}
+                <h1>golasblog</h1>
+            {% endif %}
+        </a>
     </section>
     <button id="menuToggle">
         <div></div>

data/_includes/nav.html

@@ -8,11 +8,9 @@
 
             <div class="item-controls">
                 <a href="{{ site.url }}/{{ item.url }}">
-                    {% for img in site.static_files %}
-                        {% if img.name == item.icon and img.path contains "img/icons" %}
-                            <img src="{{ site.url }}/{{ img.path }}"/>
-                        {% endif %}
-                    {% endfor %}
+                {% if item.icon != nil %}
+                    <img src="{{ site.url }}/{{ item.icon }}"/>
+                {% endif %}
                 {% if item.hue != nil %}
                     <p style="color: {{ item.hue }}">{{ item.title }}</p>
                 {% else %}

data/_includes/scripts.html

@@ -1,2 +1,3 @@
 <script src="{{ site.url }}/assets/js/jquery.slim.min.js"></script>
+<script src="{{ site.url }}/assets/js/lity.min.js"></script>
 <script src="{{ site.url }}/assets/js/tools.js"></script>

data/_includes/snippet.html

@@ -4,11 +4,11 @@
         background-image: 
         radial-gradient(ellipse closest-side, var(--c-snippetBackgroundExternal), var(--c-snippetBackgroundInternal)),
         url(
-            {% if post.image_dir == nil %}
+            {% if post.image_dir == "default" %}
                 {% assign url = post.path |  split: "." | first | split: "/" | last %}
                 {{ site.url }}/assets/posts/{{ url }}/background_image.png
-            {% else if post.image_dir != "null" %}
-                {{ post.image_dir }}
+            {% else if post.image_dir != nil %}
+                {{ site.url }}/{{ post.image_dir }}
             {% endif %}
         );
     }
@@ -16,15 +16,23 @@
 <a class="snippet__link" href="{{ post.url }}">
     <section class="snippet__data">
         <section class="snippet__data__metadata">
-            <p class="snippet__data__metadata__category" style="color: {{ site.category | where: "category", post.category | map: "hue" }}">{{ post.category | join: " · " }}</p>
+            <section class="snippet__data__metadata__category">
+                {% for category in post.category %}
+                    <p class="snippet__data__metadata__category__title" style="background: {{ site.category | where: "category", category | map: "hue"}}">{{ category }}</p>
+                {% else %}
+                    <p class="snippet__data__metadata__category__title">No category</p>
+                {% endfor %}
+            </section>
             <p class="snippet__data__metadata__date">{{ post.date | date: '%B %d, %Y' }}</p>
         </section>
         <h2 class="snippet__data__header">{{post.title }}</h2>
         <p class="snippet__data__text">{{ post.excerpt | strip_html }}</p>
-        <div class="snippet__data__author"> 
-            {% assign author = site.authors | where: "nick", post.author | first %}
-            <img src="{{ site.url }}/{{ author.photo_dir }}"/>
-            <p>{{ author.full_name }}</p>
-        </div>
+        {% if post.author != nil %}
+            <div class="snippet__data__author"> 
+                {% assign author = site.authors | where: "nick", post.author | first %}
+                <img src="{{ site.url }}/{{ author.photo_dir }}"/>
+                <p>{{ author.full_name }}</p>
+            </div>
+        {% endif %}
     </section>
 </a> 

data/_layouts/page.html

@@ -2,4 +2,6 @@
 layout: default
 ---
 
-{{ content }}
+<main class="page">
+    {{ content }}
+</main>

data/_layouts/post.html

@@ -2,6 +2,59 @@
 layout: default
 ---
 
-<section class="post">
-    {{ content }}
-</section>
+<article class="post">
+
+    <div class="post__title">
+        <h1 class="post__title__text">{{ page.title }}</h1>
+    </div>
+    <div class="post__meta"> 
+        <div class="post__meta__category">
+            {% for category in page.category %}
+                <p class="post__meta__category__title" style="background: {{ site.category | where: "category", category | map: "hue"}}">{{ category }}</p>
+            {% else %}
+                <p class="post__meta__category__title">No category</p>
+            {% endfor %}
+        </div>
+        <p class="post__meta__divider">·</p>
+        <div class="post__meta__date">
+            {{ page.date | date: '%B %d, %Y' }}
+        </div>
+        {% if page.author != nil %}
+            {% assign author = site.authors | where: "nick", page.author | first %}
+            <p class="post__meta__divider">·</p>
+            <div class="post__meta__author">
+                <p>by </p>
+                <img class="post__meta__author__photo" src="{{ site.url }}/{{ author.photo_dir }}"/>
+                <p>{{ author.full_name }}</p>
+            </div>
+        {% endif %}
+    </div>
+
+    {% if page.prevPart != nil or page.nextPart != nil %}
+        <div class="post__navigator">
+            <div
+                class="post__navigator__buttons"
+                {% if page.prevPart == nil %}
+                    style="justify-content: flex-end;"
+                {% endif %}
+            >
+                {% if page.prevPart != nil %}
+                    <a href="{% link {{ page.prevPart }} %}">
+                        <img  class="arrow-left" src="{{ site.url }}/assets/img/icons/arrow_left.svg"/>
+                        Previous
+                    </a>
+                {% endif %}
+                {% if page.nextPart != nil %}
+                    <a href="{% link {{ page.nextPart }} %}">
+                        Next
+                        <img class="arrow-right" src="{{ site.url }}/assets/img/icons/arrow_right.svg"/>
+                    </a>
+                {% endif %}
+            </div>
+        </div>
+    {% endif %}
+
+    <div class="post__content">
+        {{ content }}
+    </div>
+</article>

data/_sass/_feed.scss

@@ -20,12 +20,19 @@
             flex-direction: column;
         };
 
+        color: var(--c-feed-title);
+
         text-align: center;
         padding: 0 2rem;
+        margin-bottom: 2rem;
         min-width: 80%;
 
         h1{
             margin: 1rem 0 0 0;
+
+            @include for-size('tablet'){
+                margin: 0;
+            }
         }
     }
 
@@ -42,12 +49,12 @@
             height: 100%;
             margin: 1rem 0;
             padding: 1rem 2rem;
-            box-shadow: inset 0px 0px 14px -4px rgba(0, 0, 0, 0);
+            box-shadow: inset 0px 0px 14px -4px var(--c-snippetShadow);
             transition: $t-smooth;
 
             &:hover{
                 transform: scale(.99);
-                box-shadow: inset 0px 0px 14px -4px rgba(0,0,0,0.5);
+                box-shadow: inset 0px 0px 14px -4px var(--c-snippetShadowHover);
             }
         }
 
@@ -71,6 +78,24 @@
                 &__category{
                     text-transform: uppercase;
                     margin: 0;
+                    @include flexbox;
+
+                    &__title{
+                        color: var(--c-noCategoryText);
+                        background: var(--c-noCategoryBackground);                        
+                        padding: .2rem .5rem;
+                    }
+
+                    
+                    @include for-size('tablet'){
+                        flex-direction: column;
+
+                        p{
+                            text-align: center;
+                            width: 100%;
+                            margin: 0;
+                        }
+                    }
                 }
 
                 &__date{
@@ -89,6 +114,7 @@
             
             &__header{
                 margin: 1rem 0 0 0;
+                color: var(--c-articleHeading);
 
                 @include for-size('tablet'){
                     margin: 1rem 0 0 0;
@@ -98,12 +124,14 @@
 
             &__text{
 
+                color: var(--c-snippetHeading);
                 margin: 1rem 0 0 0;
             }
 
             &__author{
 
                 margin: 1.5rem 0 0 0;
+                color: var(--c-snippetAuthor);
 
                 @include flexbox{
                     flex-direction: row;