minimal-music-project 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b6f3663269b348a682ee95fcda38edb6cb52b797c4a42e8324f7c172361a949
-  data.tar.gz: c22f41a5ab93269a59ac0150824d1cf48e1de16357761fd35eb508e93ccfef33
+  metadata.gz: be9a010e0f48570412378b9081c7c98b679fdb3e0d0e299aece41f8569865007
+  data.tar.gz: 2c241be3e8f4c5f6ae116701b997914d6acefcf3e31ed81327a68e51d1eb2951
 SHA512:
-  metadata.gz: c6df3a006391eea0b2eb2b71cc68bc140c3422e2274207c93e4103e000a5ec7ff880b091fbd742f89a4ad19167ee3f7a499fef6e7c860cd01a16a4a8166a1baa
-  data.tar.gz: 78f4cce66af76346a6f2005871ae20bfa318511eb197fc74a9e29f8930c6c374254dfb254a3e2bbdf0b346bb9fbe6c955aee6d15687e8bb2232596306580c310
+  metadata.gz: 9ee664db5a3b579113ca4e3d1920a21d6ca24be6656633a51defafd1baca182cc6c3ad673890e65ea4c1493cab8847e5aba32648ae696c57fbed4ab9d4468dc1
+  data.tar.gz: 717caff78c28277d289d3973d5cc4e841c0c2604b5e98fca92532a50410273772f37f3a60f9da2c7021ca60fb4f415fa6afcf5e5351f653665f62b399fca60a1

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Patryk Bieszke
+Copyright (c) 2021 Patryk Bieszke
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,40 +1,56 @@
 # [minimal-music-project Jekyll theme](https://github.com/ItsMeaga1n/minimal-music-project/)
 
-[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/mmistakes/minimal-mistakes/master/LICENSE)
+[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/itsmeaga1n/minimal-music-project/master/LICENSE.txt)
 [![Jekyll](https://img.shields.io/badge/jekyll-%3E%3D%203.9-blue.svg)](https://jekyllrb.com/)
 [![Gem Version](https://badge.fury.io/rb/minimal-music-project.svg)](https://badge.fury.io/rb/minimal-music-project)
+<a href="https://ko-fi.com/itsmeaga1n">
+  <img height="20" src="https://www.ko-fi.com/img/githubbutton_sm.svg"
+    alt="Donate (Ko-fi)" />
+</a>
 
-minimal-music-project is a flexible Jekyll theme, designed for sites with content easily aggregated into categories. Demo is available [here](https://itsmeaga1n.github.io/minimal-music-project/).
+minimal-music-project is a flexible, extendable Jekyll theme. With this theme it's plain simple to create a good looking website for a music band with all the required components to list all releases and news. Demo is available [here](https://minimal-music-project.netlify.app/).
 
 ![layout examples](screenshot.png)
 
 ## Installation
 
-Add this line to your Jekyll site's `Gemfile`:
+There are three ways to install:
 
-```ruby
-gem "minimal-music-project"
-```
+* As a ruby gem theme:
 
-And add this line to your Jekyll site's `_config.yml`:
+    Add this line to your Jekyll site's `Gemfile`:
 
-```yaml
-theme: minimal-music-project
-```
+    ```ruby
+    gem "minimal-categorized"
+    ```
 
-And then execute:
+    And add this line to your Jekyll site's `_config.yml`:
 
-    $ bundle
+    ```yaml
+    theme: minimal-categorized
+    ```
 
-Or install it yourself as:
+    And then execute:
 
-    $ gem install minimal-music-project
+        $ bundle
 
-## Usage
+    Or install it yourself as:
+
+        $ gem install minimal-categorized
+
+* As a remote theme (GitHub Pages compatible)
+    
+    In your Jekyll site's _config.yml remove other themes and add this entry:
+    ```
+    remote_theme: ItsMeaga1n/minimal-categorized
+    ```
+
+* Forking/directly copying all of the theme files into your project.
 
-This theme is based on separating content into categories, which is later shown on separated sites designated to the specific content type.
+## Usage
+This theme uses pager plugin  `jekyll-paginate-v2` for pagination and `jekyll-seo-tag` for seo tags. It can be configured in main _config file.
 
-As for now, theme allows to use two main categories that will be displayed on home screen and more categories displayed only in menu to further separate content. Those are defined in `_data/menu.yml`.
+Configuration via .yml files
 
 Structure of `_data/menu.yml`:
 * menu_pages: a list of items in menu. Each item contains information:
@@ -42,14 +58,21 @@ Structure of `_data/menu.yml`:
     * url: URL for href
     * category: unique identifier of category. Used to determine which menu item is selected
     * tooltip: Tooltip for menu item
+* menu_contacts: a list of items to be displayed for a contact section in menu
+    * faicon: FavIcon to be displayed in menu
+    * url: URL for href
+    * target: target value of \<a> tag
+
 
 Structure of `_data/metaData.yml`:
 * author: Site Author name
-* logo: URL for logo image  (displayed on top of menu)
+* logo: relative url to the logo
 * cookies: customize information about site cookies
     * enabled: determine if should show cookies pop-up
     * message: text on cookie pop-up
     * agreeButtonText: text on agree button
+    * agreeButtonFnName: function in the `window` scope to execute on cookie agree
+
 
 Structure of `_data/customs.yml`:
 * custom-css: a list of urls to custom css files

data/_config.yml

@@ -5,7 +5,6 @@ description: >-
   This website was created as a demonstration for Jekyll custom theme
   named minimal-music-project. Its main feature is to make it easy to create
   websites for music projects
-baseurl: "/minimal-music-project" # the subpath of your site, e.g. /blog
 url: "https://itsmeaga1n.github.io" # the base hostname & protocol for your site, e.g. http://example.com
 author: itsmeaga1n
 twitter:

data/_data/metaData.yml

@@ -3,4 +3,5 @@ logo: assets/img/band_logo.png
 cookies:
   enabled: True
   message: This site might be using cookies! Customize your message or disable cookies in metaData.yml!
-  agreeButtonText: Agree
+  agreeButtonText: Agree
+  agreeButtonFnName: console.log

data/_includes/common-head.html

@@ -18,5 +18,5 @@
 <!-- feed -->
 <link rel="alternate" type="application/atom+xml" title="{{ site.title }}" href="{{ "feed.xml" | relative_url }}">
 
-{% include customizations.html %}
+{% include customizationsStyles.html %}
 {% seo %}

data/_includes/common.js

@@ -0,0 +1,5 @@
+(function () {
+    window.toggleExpander = function toggleExpander(x) {
+        document.getElementsByClassName("menu")[0].classList.toggle("expanded");
+    }
+})();

data/_includes/cookies.js

@@ -2,10 +2,10 @@
     const consentPropName = "cookies_consent";
     const storageType = localStorage;
 
-    shouldShowCookieConsent = () => !storageType.getItem(consentPropName);
+    areCookiesAccepted = () => storageType.getItem(consentPropName);
     acceptCookieConsent = () => storageType.setItem(consentPropName, true);
     window.addEventListener("load", () => {
-        if(!shouldShowCookieConsent()) {
+        if(areCookiesAccepted()) {
             return;
         }
         const cookieContainer = document.createElement("div");
@@ -19,6 +19,12 @@
             acceptCookieConsent();
             cookieContainer.classList.add("hidden");
             window.setTimeout(cookieContainer.remove.bind(cookieContainer), 1000);
+            window.setTimeout(cookieContainer.remove.bind(cookieContainer), 1000);
+            try {
+                {{ site.data.metaData.cookies.agreeButtonFnName }}();
+            } catch(e) {
+                console.error(e);
+            }
         }
         cookieParagraph.append(cookieContent);
         cookieContainer.append(cookieParagraph, cookieAgreeButton);

data/_includes/customizationsScripts.html

@@ -0,0 +1,7 @@
+{% for javascript in page.custom-js %}
+    <script src="{{ javascript | relative_url }}"></script>
+{% endfor %}
+
+{% for javascript in site.data.customs.custom-js %}
+    <script src="{{ javascript | relative_url }}"></script>
+{% endfor %}

data/_includes/customizationsStyles.html

@@ -0,0 +1,7 @@
+{% for css in page.custom-css %}
+    <link href="{{ css | relative_url }}" rel="stylesheet">
+{% endfor %}
+
+{% for css in site.data.customs.custom-css %}
+    <link href="{{ css | relative_url }}" rel="stylesheet">
+{% endfor %}

data/_includes/discography-entry-metadata.html

@@ -66,7 +66,7 @@
 <iframe width="100%" height="110" scrolling="no" frameborder="no" allow="autoplay"
     src="{{ include.currPost.play_soundcloud_embed.src }}"></iframe>
 <div
-    style="font-size: 10px; color: #cccccc;line-break: anywhere;word-break: normal;overflow: hidden;white-space: nowrap;text-overflow: ellipsis; font-family: Interstate,Lucida Grande,Lucida Sans Unicode,Lucida Sans,Garuda,Verdana,Tahoma,sans-serif;font-weight: 100;">
+    style="font-size: 10px; color: #cccccc;line-break: anywhere;word-break: normal;overflow: hidden;text-overflow: ellipsis; font-family: Interstate,Lucida Grande,Lucida Sans Unicode,Lucida Sans,Garuda,Verdana,Tahoma,sans-serif;font-weight: 100;">
     <a href="{{ include.currPost.play_soundcloud_embed.artist_href }}" title="{{ include.currPost.play_soundcloud_embed.artist_title }}" target="_blank"
         style="color: #cccccc; text-decoration: none;">{{ include.currPost.play_soundcloud_embed.artist_title }}</a> · <a
         href="{{ include.currPost.play_soundcloud_embed.song_href }}"

data/_includes/menu.html

@@ -5,6 +5,11 @@
                 <img src="{{ site.data.metaData.logo | relative_url }}" alt="Logo" onerror="this.style.display='none'">
             </a>
         </div>
+        <div class="menu-top_expand" onclick="toggleExpander(this)">
+            <div class="bar_top"></div>
+            <div class="bar_middle"></div>
+            <div class="bar_bottom"></div>
+        </div>
         <ul class="navigation">
             {% for menu_item in site.data.menu.menu_pages %}
             <li>

data/_includes/music-player.html

@@ -26,6 +26,11 @@
 </div>
 
 <script>
+    // Copyright (c) 2021 by EmNudge (https://codepen.io/EmNudge/pen/rRbLJQ)
+    // 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.
+
     const audioPlayer = document.getElementById("{{ include.audioData.src }}");
     const audio = new Audio(
         {% if include.audioData.is_relative_url %}
@@ -102,11 +107,7 @@
             volumeEl.classList.add("fa-volume-up");
         }
     });
-    
 
-    /**
-     * turn 128 seconds into 2:08 
-    **/
     function getTimeCodeFromNum(num) {
         let seconds = parseInt(num);
         let minutes = parseInt(seconds / 60);

data/_includes/read-more.html

@@ -3,7 +3,8 @@
     <a href="{{ include.currPost.external_url | relative_url }}" target="_blank">
         {% else %}
         <a href="{{ include.currPost.url | relative_url }}">
-            {% endif %} {% if include.currPost.external_name %}
+            {% endif %} 
+            {% if include.currPost.external_name %}
             Read more on {{ include.currPost.external_name }} &rarr;
             {% else %}
             More info &rarr;

data/_layouts/default.html

@@ -1,11 +1,6 @@
 <!doctype html>
 <html>
   <head>
-    {% if site.data.metaData.cookies.enabled %}
-      <script>
-        {% include cookies.js %}
-      </script>
-    {% endif %}
     {% include common-head.html %}
   </head>
   <body>
@@ -14,5 +9,14 @@
           {{ content }}
           {% include footer.html %}
       </main>
+      {% if site.data.metaData.cookies.enabled %}
+      <script>
+        {% include cookies.js %}
+      </script>
+    {% endif %}
+    <script>
+      {% include common.js %}
+    </script>
+    {% include customizationsScripts.html %}
   </body>
 </html>

data/_layouts/posts_feed.html

@@ -29,7 +29,7 @@ category: home
                     {{ post.description }}
                 </p>
             </section>
-            {% include read-more.html currPost=include.currPost %}
+            {% include read-more.html currPost=post %}
         </article>
         {% else %}
         <hr>

data/_sass/styles/_cookies.scss

@@ -8,9 +8,9 @@
     opacity: 0.95;
     -webkit-transition: opacity 800ms, visibility 800ms;
     transition: opacity 800ms, visibility 800ms;
-    bottom: 30px;
-    left: 40px;
-    max-width: 300px;
+    bottom: 40px;
+    left: 50px;
+    max-width: 40vw;
     border-radius: 3px;
     border: 3px solid $black;
 

data/_sass/styles/_defaults.scss

@@ -30,7 +30,7 @@ body {
 }
 main {
     .content-container {
-        margin: 3.5em auto 0 auto;
+        margin: 3.5em auto 0 0;
         width: 90%;
         padding: 0px 18px 24px;
         flex-grow: 1;
@@ -65,19 +65,17 @@ main {
             }
             & > a {
                 color: $p_text;
-                &:hover {
-                    text-decoration: underline $black;
-                }
+                @include underline-on-hover($black);
             }
         }
     }
 }
+
 a {
     text-decoration-line: none;
     color: inherit;
     transition: all 0.4s ease-in-out 0s;
 }
-
 a, p, li {
     font-size: 1.1em;
 }
@@ -112,6 +110,7 @@ img {
         .content-container {
             width: 100%;
             padding: 0px 9px 12px;
+            margin-top: 0;
         }
     }
 }
@@ -130,8 +129,6 @@ audio {
     color: #000000;
     a {
         font-size: 0.9em;
-        &:hover {
-            text-decoration: underline;
-        }
+        @include underline-on-hover($black);
     }
 }

data/_sass/styles/_discography.scss

@@ -9,6 +9,7 @@
             height: 20vw;
             border: 1px solid #CCC;
             max-width: 500px;
+            max-height: 500px;
             &-wrapper {
                 display: block;
                 margin-right: 0.5em;
@@ -21,8 +22,8 @@
             padding-bottom: 0.5em;
             color: $p_text;
         }
-        a:hover {
-            text-decoration: underline $p_text;
+        a {
+            @include underline-on-hover($p_text);
         }
         section {
             width: 100%;
@@ -32,9 +33,7 @@
             margin-top: 3vw;
             font-size: 2em;
             margin-bottom: 0.6em;
-            &:hover {
-                text-decoration: underline;
-            }
+            @include underline-on-hover($p_text);
         }
 
         &_summary {

data/_sass/styles/_layout.scss

@@ -13,10 +13,10 @@ main {
     left: $menu-size;
     top: 0;
     @include mobile {
-        top: $menu-size;
+        top: $mobile-menu-height;
         left: 0;
         width: 100%;
-        height: calc(100% - #{$menu-size});
+        height: calc(100% - #{$mobile-menu-height});
     }
     &.no-menu {
         width: 100%;

data/_sass/styles/_menu.scss

@@ -14,26 +14,84 @@
     box-sizing: border-box;
     padding: 8px 0 0 22px;    
     overflow: hidden;
-
+    @include mobile {
+        flex-direction: row;
+        width: 100%;
+        max-height: $mobile-menu-height;
+    }
+    &.expanded {
+        z-index: 10;
+        .menu-top_expand  {
+                .bar_top {
+                    -webkit-transform: rotate(-45deg) translate(-8px, 8px);
+                    transform: rotate(-45deg) translate(-8px, 8px);
+                  }
+                  
+                  .bar_middle {opacity: 0;}
+                  
+                  .bar_bottom {
+                    -webkit-transform: rotate(45deg) translate(-8px, -8px);
+                    transform: rotate(45deg) translate(-8px, -8px);
+              }
+          }
+          .navigation {
+            @include mobile {
+                display: block;
+                position: fixed;
+                left: 0;
+                top: $mobile-menu-height;
+                height: calc(100% - #{$mobile-menu-height});
+                width: 100%;
+                background-color: $white;
+                padding-left: 2em;
+            }
+          }
+          .menu-contact {
+              display: flex;
+              position: fixed;
+              bottom: 0.5em;
+              left: 1em;
+          }
+      }
     &-top {
         box-sizing: border-box;
         height: 100%;
         flex-grow: 1;
         padding-right: 3px;
-
         &_logo {
             max-width: 100px;
             margin-bottom: 1em;
             a {
                 color: #000000;
                 img {
-                    max-height: 100%;
+                    max-height: 100px;
+                    @include mobile {
+                        max-height: calc(#{$mobile-menu-height} - 15px);
+                    }
                     width: auto;
                     max-width: 100%;
                     border: 0;
                 }
             }
         }
+        &_expand {
+            display: none;
+            @include mobile {
+                display: inline-block;
+            }
+            cursor: pointer;
+            flex-grow: 0;
+            position: absolute;
+            right: 10px;
+            top: 15px;
+            .bar_top, .bar_middle, .bar_bottom {
+                width: 35px;
+                height: 5px;
+                background-color: #333;
+                margin: 6px 0;
+                transition: 0.4s;
+              }
+          }          
     }
     ul, ol, dl {
         li, dt {
@@ -51,8 +109,9 @@
                 letter-spacing: 3px;
                 font-size: 1em;
                 &:hover {
-                    color: $black;
-
+                    transition: all 0.3s ease-in-out 0s;
+                    color: $p_light;
+                    text-decoration: none;
                 }
                 &.selected {
                     font-weight: 600;
@@ -70,11 +129,20 @@
         }
     }
 
+    .navigation {
+        @include mobile {
+            display: none;
+        }
+    }
+
     &-contact {
         display:flex;
         justify-content:left;
         margin-bottom: 0.6em;
         flex-wrap: wrap;
+        @include mobile {
+            display: none;
+        }
         a {
             color: $p_text;
             cursor:pointer;
@@ -89,4 +157,6 @@
             }
         }
     }
+
+    
 }

data/_sass/styles/_post.scss

@@ -67,9 +67,7 @@
         }
         a {
             color: $p_text;
-            &:hover {
-                text-decoration: underline $p_text;
-            }
+            @include underline-on-hover($p_text);
         }
     }
 

data/_sass/styles/_posts_feed.scss

@@ -7,6 +7,13 @@ $image-dim: 192px;
     justify-content: flex-start;
     align-items: flex-start;
     color: $p_text;
+    hr {
+        @include mobile {
+            &:first-of-type {
+                margin-top: 0;
+            }
+        }
+    }
     article {
         width: 100%;
         position: relative;
@@ -22,8 +29,15 @@ $image-dim: 192px;
     }
     a {
         line-height: 1.1em;
+        text-decoration: underline;
+        text-decoration-color: transparent;
+        transition: 0.4s;
+        -webkit-text-decoration-color: transparent;
+        -moz-text-decoration-color: transparent;
         &:hover {
-            text-decoration: underline $black;
+            text-decoration-color: $black;
+            -webkit-text-decoration-color: $black;
+            -moz-text-decoration-color: $black;
         }
     }
     .article-date {

data/_sass/variables/_colors.scss

@@ -1,4 +1,5 @@
 $black: #000000;
 $white: #FFF;
-$hyperlink: #2d00a8;
+$hyperlink: #290099;
 $p_text: #000000;
+$p_light: #888888;

data/_sass/variables/_layout.scss

@@ -1,6 +1,7 @@
 $tablet-width: 768px;
 $desktop-width: 1024px;
-$menu-size: 200px;
+$menu-size: 240px;
+$mobile-menu-height: 75px;
 $minimal-menu-size: 50px;
 $gap: 30px;
 $pop-ups-z-1: 100;

data/_sass/variables/_mixins.scss

@@ -1,3 +1,16 @@
+@mixin underline-on-hover($underline-color) {
+  text-decoration: underline;
+  text-decoration-color: transparent;
+  transition: 0.4s;
+  -webkit-text-decoration-color: transparent;
+  -moz-text-decoration-color: transparent;
+  &:hover {
+    text-decoration-color: $underline-color;
+    -webkit-text-decoration-color: $underline-color;
+    -moz-text-decoration-color: $underline-color;
+  }
+}
+
 @mixin tooltip {
     position: relative;
     &:hover .tooltip {
@@ -35,13 +48,8 @@
 
 @mixin hyperlink-convention {
     a {
-      transition: all 300ms ease 0s;
       cursor: pointer;
-      text-decoration-line: none;
+      @include underline-on-hover($hyperlink);
       color: $hyperlink;
-      &:hover {
-        text-decoration: underline $hyperlink;
-
-      }
   }
 }

data/pages/about.html

@@ -7,7 +7,7 @@ category: about
 ---
 <div class="content-container about">
     <h1>About</h1>
-    It's a good place to write something about the project!
+    It's a good place to write something about the project. This projects repository is located on <a href="https://github.com/ItsMeaga1n/minimal-music-project" target="_blank">GitHub</a>. Since you are here, feel free to check out my other stuff either on <a href="https://github.com/ItsMeaga1n" target="_blank">GitHub</a> or on my <a href="http://itsmeaga1n.github.io" target="_blank">blog</a>!
 
     <hr />
     <p>
@@ -33,4 +33,22 @@ category: about
             </li>
         </ul>
     </p>
-</div>
+</div>
+
+<style>
+    a {
+        text-decoration: underline;
+        text-decoration-color: transparent;
+        transition: 0.4s;
+        -webkit-text-decoration-color: transparent;
+        -moz-text-decoration-color: transparent;
+        cursor: pointer;
+        color: #290099;
+    }
+  a:hover {
+        text-decoration-color: #290099;
+        transition: 0.4s;
+        -webkit-text-decoration-color: #290099;
+        -moz-text-decoration-color: #290099;
+      }
+</style>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minimal-music-project
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Patryk Bieszke
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -39,8 +39,10 @@ files:
 - _data/menu.yml
 - _data/metaData.yml
 - _includes/common-head.html
+- _includes/common.js
 - _includes/cookies.js
-- _includes/customizations.html
+- _includes/customizationsScripts.html
+- _includes/customizationsStyles.html
 - _includes/discography-entry-metadata.html
 - _includes/discography-entry.html
 - _includes/footer.html

data/_includes/customizations.html

@@ -1,15 +0,0 @@
-{% for javascript in page.custom-js %}
-    <script src="{{ javascript | relative_url }}"></script>
-{% endfor %}
-
-{% for javascript in site.data.customs.custom-js %}
-    <script src="{{ javascript | relative_url }}"></script>
-{% endfor %}
-
-{% for css in page.custom-css %}
-    <link href="{{ css | relative_url }}" rel="stylesheet">
-{% endfor %}
-
-{% for css in site.data.customs.custom-css %}
-    <link href="{{ css | relative_url }}" rel="stylesheet">
-{% endfor %}