minimal-music-project 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94130b90c49b3c5423eeb20740ef30d0ef726224d45ca6eda8c0d1bd29746e1b
-  data.tar.gz: b142daa5b762e53446bc6b92a7a40c3801a30173c9e5f9c5d90f345cf1b1477c
+  metadata.gz: be9a010e0f48570412378b9081c7c98b679fdb3e0d0e299aece41f8569865007
+  data.tar.gz: 2c241be3e8f4c5f6ae116701b997914d6acefcf3e31ed81327a68e51d1eb2951
 SHA512:
-  metadata.gz: 123a67632b7566211e8a852afc54ceaf1bc235ae44af2f4838b5796f193e550a4992aac85b6b8ce6dae856d3b5289ee42edaec994d68cfb78d90c60326898abe
-  data.tar.gz: 16f67b30d7c9654e6c9d659ef41ce789b1cd30ca547efff8e1c82bbd4c9c62d2916bf0cf6200c30d0b2778a7ac3a6c010d46334c0100920c68aed4abecf545df
+  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
+    ```
 
-This theme is based on separating content into categories, which is later shown on separated sites designated to the specific content type.
+* Forking/directly copying all of the theme files into your project.
+
+## 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,10 +58,25 @@ 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
-avatar_url: URL for avatar (for about page)
+* author: Site Author name
+* 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
+* custom-js: a list of urls to custom javascript files
 
 ## Contributing
 
@@ -63,4 +94,4 @@ To add a custom directory to your theme-gem, please edit the regexp in `minimal-
 ## License
 
 The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
+Custom Volume Slider was developed with the fundaments based on [codepen project](https://codepen.io/EmNudge/pen/rRbLJQ), thus this component is licensed under [Copyright (c) 2021 by EmNudge](https://codepen.io/EmNudge/pen/rRbLJQ).

data/_config.yml

@@ -1,26 +1,10 @@
-# Welcome to Jekyll!
-#
-# This config file is meant for settings that affect your whole blog, values
-# which you are expected to set up once and rarely edit after that. If you find
-# yourself editing this file very often, consider using Jekyll's data files
-# feature for the data you need to update frequently.
-#
-# For technical reasons, this file is *NOT* reloaded automatically when you use
-# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
-
-# Site settings
-# These are used to personalize your new site. If you look in the HTML files,
-# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
-# You can create any custom variable you would like, and they will be accessible
-# in the templates via {{ site.myvariable }}.
 title: minimal-music-project
 tagline: A site showing the usage of Jekyll custom theme
 email: email@example.com
-description: >- # this means to ignore newlines until "baseurl:"
+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:
@@ -28,12 +12,21 @@ twitter:
   card: summary
 plugins:
   - jekyll-seo-tag
-
+  - jekyll-feed
+  - jekyll-sitemap
+  - jekyll-paginate-v2
 # Build settings
 markdown: kramdown
 remote_theme: ItsMeaga1n/minimal-music-project
-# Exclude these files from production site
-exclude:
+permalink: /:title.html
+pagination:
+  enabled: true
+  per_page: 4
+  limit: 0
+  sort_field: 'date'
+  sort_reverse: true
+
+  exclude:
   - CHANGELOG.md
   - CNAME
   - Gemfile

data/_data/menu.yml

@@ -4,16 +4,30 @@ menu_pages:
   category: home
 
 - title: Discography
-  url: /discography.html
+  url: /discography/
   category: discography
   tooltip: Discography tooltip
 
 - title: Collaborations
-  url: /collaborations.html
+  url: /collaborations/
   category: collaborations
   tooltip: Collaborations tooltip
 
 - title: About
   url: about.html
   category: about
-  tooltip: This is about
+  tooltip: This is about
+
+menu_contacts:
+- faicon: fab fa-soundcloud
+  url: 
+  target: _blank
+- faicon: fab fa-twitter
+  url: 
+  target: _blank
+- faicon: fas fa-envelope
+  url:
+  target: 
+- faicon: fas fa-rss
+  url: /feed.xml
+  target: _blank

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

@@ -3,14 +3,20 @@
 <link rel="stylesheet" href="{{ '/assets/styles/styles.css' | relative_url }}">
 <link rel="stylesheet" href="https://indestructibletype.com/fonts/Jost.css" type="text/css" charset="utf-8" />
 <script src="https://kit.fontawesome.com/79c31398dc.js" crossorigin="anonymous"></script>
+
+<!-- favicon -->
 <link rel="apple-touch-icon" sizes="180x180" href="{{ '/assets/img/apple-touch-icon.png' | relative_url }}">
 <link rel="icon" type="image/png" sizes="32x32" href="{{ '/assets/img/favicon-32x32.png' | relative_url }}">
 <link rel="icon" type="image/png" sizes="16x16" href="{{ '/assets/img/favicon-16x16.png' | relative_url }}">
 <link rel="manifest" href="{{ '/assets/img/site.webmanifest' | relative_url }}">
 <link rel="mask-icon" href="{{ '/assets/img/safari-pinned-tab.svg'| relative_url }}" color="#5bbad5">
-<link rel="shortcut icon" href="{{' /assets/img/favicon.ico' | relative_url }}">
+<link rel="shortcut icon" href="{{'/assets/img/favicon.ico' | relative_url }}">
 <meta name="msapplication-TileColor" content="#da532c">
 <meta name="msapplication-config" content="{{ '/assets/img/browserconfig.xml' | relative_url }}">
 <meta name="theme-color" content="#ffffff">
-{% include customizations.html %}
+
+<!-- feed -->
+<link rel="alternate" type="application/atom+xml" title="{{ site.title }}" href="{{ "feed.xml" | relative_url }}">
+
+{% 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

@@ -0,0 +1,80 @@
+<p class="discography-album_release-date">
+    release date: {{ include.currPost.date | date_to_long_string }}
+</p>
+
+{% if include.currPost.type %}
+<p class="discography-album_type">
+    release type: {{ include.currPost.type }}
+</p>
+{% endif %}
+
+{% assign playArray = include.currPost.play | size %}
+{% if playArray != 0 %}
+<p class="discography-album_play">
+    play:
+    {% for play in include.currPost.play %}
+    <a href="{{ play.url }}" target="_blank">{{ play.name }}</a>
+    {% if forloop.last == false %}
+    |
+    {% endif %}
+    {% endfor %}
+</p>
+{% endif %}
+
+{% assign downloadArray = include.currPost.download | size %}
+{% if downloadArray != 0 %}
+<p class="discography-album_download">
+    download:
+    {% for download in include.currPost.download %}
+    <a href="{{ download.url }}" target="_blank">{{ download.name }}</a>
+    {% if forloop.last == false %}
+    |
+    {% endif %}
+    {% endfor %}
+</p>
+{% endif %}
+
+{% assign buyArray = include.currPost.buy | size %}
+{% if buyArray != 0 %}
+<p class="discography-album_buy">
+    buy from:
+    {% for buy in include.currPost.buy %}
+    <a href="{{ buy.url }}" target="_blank">{{ buy.name }}</a>
+    {% if forloop.last == false %}
+    |
+    {% endif %}
+    {% endfor %}
+</p>
+{% endif %}
+
+{% assign otherArray = include.currPost.other | size %}
+{% if otherArray != 0 %}
+<p class="discography-album_other">
+    other links:
+    {% for other in include.currPost.other %}
+    <a href="{{ other.url }}" target="_blank">{{ other.name }}</a>
+    {% if forloop.last == false %}
+    |
+    {% endif %}
+    {% endfor %}
+</p>
+{% endif %}
+{% if include.currPost.play_here %}
+{% include music-player.html audioData=include.currPost.play_here %}
+{% endif %}
+{% if include.currPost.play_soundcloud_embed %}
+<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;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 }}"
+        title="{{ include.currPost.play_soundcloud_embed.song_title }}" target="_blank"
+        style="color: #cccccc; text-decoration: none;">{{ include.currPost.play_soundcloud_embed.song_title }}</a></div>
+{% endif %}
+{% if include.currPost.play_bandcamp_embed %}
+<iframe style="border: 0; width: 100%; height: 120px;"
+    src="{{ include.currPost.play_bandcamp_embed.src }}" seamless>
+    <a href="{{ include.currPost.play_bandcamp_embed.href }}">{{ include.currPost.play_bandcamp_embed.title }}</a></iframe>
+{% endif %}

data/_includes/discography-entry.html

@@ -0,0 +1,25 @@
+<article class="discography-album">
+    <header>
+        <figure class="discography-album_cover-wrapper">
+            <div class="discography-album_cover">
+                <img src="{{ include.currPost.image | relative_url }}" alt="{{ page.image_alt }}" />
+            </div>
+        </figure>
+    </header>
+    <section>
+        {% if include.currPost.external_url %}
+        <a href="{{ include.currPost.external_url | relative_url }}" target="_blank">
+            {% else %}
+            <a href="{{ include.currPost.url | relative_url }}">
+                {% endif %}
+                <h2 class="discography-album_title">
+                    {{ include.currPost.title }}
+                </h2>
+            </a>
+            <p class="discography-album_summary">
+                {{ include.currPost.description }}
+            </p>
+            {% include discography-entry-metadata.html currPost=include.currPost %}
+        </section>
+    {% include read-more.html currPost=include.currPost %}
+</article>

data/_includes/menu.html

@@ -5,31 +5,31 @@
                 <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>
-                <a href="{{ menu_item.url | relative_url }}" category="{{ menu_item.category }}" title="{{ menu_item.tooltip }}">
+                <a href="{{ menu_item.url | relative_url }}" category="{{ menu_item.category }}" title="{{ menu_item.tooltip }}"
+                {% if menu_item.category == page.category or page.categories contains menu_item.category %}
+                    class="selected"
+                {% endif %}
+                >
                     <span>{{ menu_item.title }}</span>
                 </a>
             </li>
             {% endfor %}
         </ul>
     </div>
-</aside>
+    <div class="menu-contact">
+        {% for contact in site.data.menu.menu_contacts %}
 
-<script>
-    (function() {
-        window.addEventListener("load", () => {
-            const navigation = document.getElementsByClassName("navigation")[0];
-            const selectedCategory = navigation.getElementsByTagName("a");
-            const currCategory = "{{ page.category }}";
-            
-            for(menuItem of selectedCategory) {
-                if(menuItem.getAttribute("category") === currCategory) {
-                    menuItem.classList.add("selected");
-                    return;
-                }
-            }
-        });
-    })();
-</script>
+        <a href="{{ contact.url | relative_url }}" target="{{ contact.target }}">
+            <i class="{{ contact.faicon }}"></i>
+        </a>
+        {% endfor %}
+    </div>
+</aside>