jekyll-theme-simplex 0.9.3 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3cac9e8df49ff462e3c029bbcd0abfd2cc22ff994e5248c38a3844a4c6514aa
-  data.tar.gz: c6fda47b2058d38c0235c07354bd694cfe14ff9159659075f0f68d002200d2a0
+  metadata.gz: 93c3ac147d6c55f9bbd60f5d62033ec93987b9e4818fba0636a90f78ba69f43d
+  data.tar.gz: 72fb35482a61d9124761acab1997469d4633b295ef692bd420295b73783757ce
 SHA512:
-  metadata.gz: c65ac0e803c19c3f285ae0482f0f6b5ecc5e2a4257c1054f8f6a7e7059d64e7a7e86ff87980ce136cb7300b66cf5c18960ee6f6e5cac765caf4dbbcf92723c67
-  data.tar.gz: 3002eb374d61022b160f319f359865d331b7d691b0aba91689b5ba61640ca885a9c0083d3e2f22bf14f11a928b92bf9ef3b079b84faa5b46b18327c53aa9b553
+  metadata.gz: 624cb1f9efa420a20f11e0041fa65c3283d2b5a6e2ee4c305b7bdc53035654bf722888fe720b10700fbae392d5a73e919503ed8c64444028a8906fb942579969
+  data.tar.gz: 28e21b6169306c480aec7964add307c7288703dc3f2a2045082f3ee12fa71b5dd0866867eb2c7b7860372ba4bc39fb0618bbb65560c260ee8b2fcc5025285c45

data/README.md

@@ -6,6 +6,23 @@
 
 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`:
@@ -110,6 +127,51 @@ 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...).
 
@@ -134,7 +196,18 @@ You can use following predefined colors:
 --c-themeHuePurple: #9F00CE;
 --c-themeHueBrown: #230007;
 ```
-This colors are CSS variables, usage: `var(--var-name)`
+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
  
@@ -149,6 +222,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.
 
+## 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).
+
+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,11 +1,13 @@
 <header class="header">
     <section class="logo">
-        {% if site.logo_img != nil %}
-            <h1 style="display: none;">golasblog</h1>
-            <img class="logo__img" src={{site.logo_img}}/>
-        {% else %}
-            <h1>golasblog</h1>
-        {% endif %}
+        <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/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/_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);
             }
         }
 
@@ -74,10 +81,21 @@
                     @include flexbox;
 
                     &__title{
-                        color: white;
-                        background: var(--c-themePrimaryDark);
+                        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{
@@ -96,6 +114,7 @@
             
             &__header{
                 margin: 1rem 0 0 0;
+                color: var(--c-articleHeading);
 
                 @include for-size('tablet'){
                     margin: 1rem 0 0 0;
@@ -105,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;

data/_sass/_footer.scss

@@ -7,6 +7,8 @@
 
     @include flexbox;
     padding: 1rem 0 0 0;
+    margin-top: auto;
+    color: var(--c-footerText);
 
     &__about{
 
@@ -35,6 +37,7 @@
                 height: 1.25rem;
                 margin: 0 .5rem;
                 transition: $t-smooth;
+                filter: var(--c-footerImageFilter);
 
                 &:hover{
                     transform: scale(1.05) rotate(-5deg);

data/_sass/_global.scss

@@ -25,12 +25,10 @@ body{
     margin: 0;
     min-height: 100vh;
     
-    display: grid;
-    gap: 0 100px;
-    grid-template-areas: 
-        "header"
-        "main"
-        "footer";
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    justify-content: center;
 }
 
 h1,h2,h3,h4,h5,h5,h6{
@@ -65,3 +63,95 @@ a{
         color: var(--c-linkActive);
     }
 }
+
+table:not([class]){
+    border-collapse: collapse;
+    border-spacing: 0;
+    border: 1px solid var(--c-tableBorder);
+
+    th,td{
+        padding: .25rem;
+        border: 1px solid var(--c-tableBorder);
+    }
+}
+
+.highlight{
+
+    margin: 2rem 0;
+    transition: $t-smooth;
+    box-shadow: inset 0px 0px 14px -4px var(--c-codeShadow);
+
+    &:hover{
+        box-shadow: inset 0px 0px 14px -4px var(--c-codeShadowHover);
+    }
+
+    max-width: calc(100vw - 2rem);
+    overflow-x: auto;
+
+    pre{
+        margin: 0;
+        padding: 1rem;
+    }
+}
+
+.sx-center{
+
+    display: flex;
+    align-items: center;
+    justify-content: center;
+}
+
+.sx-button{
+
+    width: 100%;
+    margin: 1rem 0;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+
+    &__content{
+
+        &:link, &:visited, &:hover, &:active{
+            color: var(--c-themePrimaryLight);
+        }
+        text-decoration: none;
+        width: fit-content;
+        padding: .5rem 1rem;
+        display: flex;
+        align-items: center;
+        justify-content: center;
+        transition: $t-smooth;
+
+        &.red{background-color: var(--c-themeHueRed);}
+        &.orange{background-color: var(--c-themeHueOrange);}
+        &.green{background-color: var(--c-themeHueGreen);}
+        &.blue{background-color: var(--c-themeHueBlue);}
+        &.purple{background-color: var(--c-themeHuePurple);}
+        &.brown{background-color: var(--c-themeHueBrown);}
+
+        img{
+            margin-right: 1rem;
+            height: 1rem;
+            filter: brightness(0) invert(1);
+        }
+
+        &:hover{
+            letter-spacing: .05rem;
+        }
+    }
+}
+
+.sx-subtitle{
+    font-style: italic;
+    color: var(--c-subtitle);
+}
+
+.sx-picture{
+
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    justify-content: center;
+    width: fit-content;
+    margin: 1.5rem 0;
+}

data/_sass/_header.scss

@@ -13,11 +13,22 @@
 
     .logo{
 
-        h1{
-            margin: 0;
-        }
-        &__img{
-            height: 2rem;
+        &__link{
+
+            text-decoration: none;
+            color: var(--c-themePrimaryDark);
+            transition: $t-smooth;
+
+            &:hover{
+                letter-spacing: .5rem;
+            }
+            h1{
+                margin: 0;
+            }
+            &__img{
+                filter: var(--c-headerImageFilter);
+                height: 2rem;
+            }
         }
     }
 
@@ -27,7 +38,7 @@
         outline: none;
         cursor: pointer;
         
-        margin: 2rem 0;
+        margin: 2rem 0 1rem 0;
         padding: 0;
         font-size: 1rem;
         width: 3em;
@@ -93,7 +104,7 @@
 
                     img,p{
                         transition: $t-smooth;
-                        filter: brightness(0);
+                        filter: var(--c-menuItemsFilter);
                     }
     
                     img{
@@ -134,7 +145,7 @@
                     max-height: 0;
                     width: 250px;
                     overflow: hidden;
-                    box-shadow: inset 0px 0px 14px -4px rgba(0,0,0,0.5);
+                    box-shadow: inset 0px 0px 14px -4px var(--c-menuShadow);
                     transition: $t-smooth;
                     flex-direction: column;
 
@@ -159,7 +170,7 @@
       
                     img{
                         transform: scale(1.1);
-                        filter: none;
+                        filter: var(--c-menuItemsFilterHover);
 
                         @include for-size('tablet'){
                             transform: scale(1);
@@ -168,7 +179,7 @@
 
                     p{
                         letter-spacing: .1rem;
-                        filter: none;
+                        filter: var(--c-menuItemsFilterHover);
 
                         @include for-size('tablet'){
                             letter-spacing: .2rem;
@@ -263,11 +274,12 @@
         }
 
         @include for-size('tablet'){
-            box-shadow: inset 0px 0px 14px -4px rgba(0,0,0,0.5);
+            box-shadow: inset 0px 0px 14px -4px var(--c-menuShadow);
 
             transition: $t-smooth;
             max-height: 0;
             overflow: hidden;
+            margin: 0;
             &.open{
                 max-height: $s-m-menuMaxHeight;
             }