mallow-theme 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 427f42402fa7b301fa248fd3d32dc2d9da8b97bcbbd429cfa71853df8bda03ee
-  data.tar.gz: 38d429231b34c9026961d87edbc2f5324f1efca04c736b45614499c71ee77bf3
+  metadata.gz: 2d4b50a9fcc8b6a678c63b440c2f897b6fcac92fe3b487fa66992a5ea9ea74d0
+  data.tar.gz: 15a55f020ee637490421eefa9e074dbb8e205806320e06b386c30a3e8bd570a9
 SHA512:
-  metadata.gz: 00a19af970e9b59b7ed3b43f2e0594c9d3c6ca6eabc8a90e2ff0c1d67c042801ff6c3d614fc723ac43870a6007f12ee796ebca17e6bc47962402b60ea8ee1817
-  data.tar.gz: 8d7db2d089e744b45f868ea43533a988b21231cd62d606d3be01acba650f25ff53a10ef9cc1446e05e06c7625d279dc2945f16d9ed154a749aa17080a61343c5
+  metadata.gz: 74518bc3c739a7494ffb275b3662dd05d4b5f41a1e44cc87733b863c1c386c804e8152c3f16030c99df0926624e8b0fb81d9287ad4d5c66e79426b16c975e9e9
+  data.tar.gz: 8e354175b9876cd0924d2e7fd3b385083570edf53f68b82837776589b41948f67c2296e9f5699f0d095365c367c20f02b442b4aca4005fe547f3cc658d595fcd

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, doamatto (Ronchetto, Matthew)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,21 +1,21 @@
-# Mallow
-
-[![Gem Version](https://badge.fury.io/rb/mallow-theme.svg)](https://badge.fury.io/rb/mallow-theme)
-
-**This is in active developement. [You can see the roadmap here.](https://trello.com/b/6uBEAJwj)**
-
-Mallow is a simple one-pager theme that puts emphesis on simplicty and speed.
-
-### Installation
-
-You can install Mallow one of two ways:
-
-**a) Cloning from GitHub**
-You can clone the repo and [configure based on what's recommended in the wiki of this repo](https://github.com/doamatto/mallow-theme/wiki/Configuration).
-
-**b) Installing the Gem**
-You can also use [`gem install mallow-theme`](https://rubygems.org/gems/mallow-theme) and [configure based on what's recommended in the wiki of this repo](https://github.com/doamatto/mallow-theme/wiki/Configuration).
-
-### Credits
-
-This theme was designed in part by Ethan Facione, also known as [Rainpelt29](https://rainpelt29.github.io), for his new portfolio. With his permission, I released the theme here on GitHub and on Ruby Gems.
+# Mallow
+
+[![Gem Version](https://badge.fury.io/rb/mallow-theme.svg)](https://badge.fury.io/rb/mallow-theme) [![Gem Downloads](https://img.shields.io/gem/dt/mallow-theme?color=68%2C%20204%2C%2017)](https://badge.fury.io/rb/mallow-theme)
+
+Mallow is a simple one-pager theme that puts emphesis on simplicty and speed.
+
+**Why I highly suggest you don't use Mallow**
+
+You might think "Why would you, the person who made Mallow, tell me not to use Mallow?" It's actually really simple. I made this theme but designed it in a way that would make it horrible for anyone. I've spent about 2 months now trying different designs to get a mobile sidebar working (with and without JavaScript), but all of them go away from the main design of Mallow. For that reason, for anyone cares about mobile users and their ability to use the site, I cannot recommend you to use my theme. However, I can recommend the more mobile-friendly Jekyll theme I've made, [Nano](https://github.com/doamatto/nano); it's similar to Mallow and I personally use it as I don't think anything beats it (that I've released as a template, that is). **TL;DR is that this looks horrible on small screens and that you should use something else if you care about mobile users**.
+
+## Installation
+
+Installing Mallow is simple. Start by downloading the latest version of Mallow [via the releases page](https://github.com/doamatto/mallow-theme/releases/latest). Afterwards, using Gem, install bundler (`gem install bundler`). Then, run `bundle install` to install everything you need for Mallow to work properly. You're now ready to configure your installation and deploy wherever.
+
+## About Creators
+
+### doamatto - Lead Designer, Developer
+Based in California, I’m a high school student who works on making tools for people, not products. I strive to give people tools that empower them to do amazing things. To empower people there’s two things that I’m always consistent with from tool to tool: the way a user interacts with the tool is simple, but powerful and that privacy is given by default. _[Click here to go to Matt's Site](https://doamatto.xyz)_
+
+### Rainpelt29 - Co-Designer
+Based in Michigan, I’m an almost highschooler with a creative and ever-working mind. I am always working on creative visions to bring new ideas and sometimes worlds to life using film and video. My goal with all of these is the same. Make something that people will enjoy. And in anything I work on, I make sure that goal is met. _[Click here to go to Ethan's Site](https://rainpelt29.github.io/rainpelt29site)_

data/_includes/analytics.html

@@ -0,0 +1,41 @@
+<!-- Analytics Start -->
+{% if site.simpleanalytics == true %}
+<script src="https://scripts.simpleanalyticscdn.com/latest.js" async defer></script>
+<noscript>
+  <img class="pxl" src="https://queue.simpleanalyticscdn.com/noscript.gif" alt="">
+</noscript>
+{% elsif site.matomoanalytics == true %}
+<!-- Matomo -->
+<script>
+  var _paq = window._paq || [];
+  _paq.push(["setDoNotTrack", true]);
+  _paq.push(["disableCookies"]);
+  _paq.push(['trackPageView']);
+  _paq.push(['enableLinkTracking']);
+  (function() {
+    var u="https://{{site.matomourl}}/";
+    _paq.push(['setTrackerUrl', u+'matomo.php']);
+    _paq.push(['setSiteId', '{{site.matomositeid}}']);
+    var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+    g.type='text/javascript'; g.async=true; g.defer=true; g.src='https://cdn.matomo.cloud/{{site.matomourl}}/matomo.js'; s.parentNode.insertBefore(g,s);
+  })();
+</script>
+<noscript>
+  <p>
+    <img class="pxl" src="https://{{site.matomourl}}/matomo.php?idsite=1&amp;rec=1" style="border:0;" alt="">
+  </p>
+</noscript>
+{% elsif site.fathomanalytics == true %}
+{% if site.customfathomurl != "" %}
+<script src="https://{{site.customfathomurl}}" site="{{site.fathomsite}}" honor-dnt="true" async defer></script>
+{% else %}
+<script src="https://cdn.usefathom.com/script.js" site="{{site.fathomsite}}" honor-dnt="true" async defer></script>
+{% endif %}
+{% elsif site.plausibleanalytics == true %}
+{% if site.customplausibleurl != "" %}
+<script data-domain="{{site.github.url}}" src="https://{{site.customplausibleurl}}/js/index.js" async defer></script>
+{% else %}
+<script data-domain="{{site.github.url}}" src="https://plausible.io/js/plausible.js" async defer></script>
+{% endif %}
+{% endif %}
+<!-- Analytics End -->

data/_includes/csp.html

@@ -0,0 +1,23 @@
+{% if site.simpleanalytics == true %}
+<meta http-equiv="Content-Security-Policy" content="script-src 'self' https://scripts.simpleanalyticscdn.com/latest.js">
+{% elsif site.fathomanalytics == true %}
+  {% if site.customfathomurl == "" %}
+<meta http-equiv="Content-Security-Policy" content="script-src 'self' https://cdn.usefathom.com/script.js">
+  {% else %}
+<meta http-equiv="Content-Security-Policy" content="script-src 'self' https://{{site.customfathomurl}}">
+  {% endif %}
+{% elsif site.matomoanalytics %}
+<meta http-equiv="Content-Security-Policy" content="script-src 'self' 'sha256-qj/jwzjem2sfrDp/CEX8ODDzwfezTtpX43MRAcQTuUQ=' https://cdn.matomo.cloud/{{site.matomourl}}/matomo.js">
+{% elsif site.plausibleanalytics %}
+  {% if site.customplausibleurl == "" %}
+<meta http-equiv="Content-Security-Policy" content="script-src 'self' https://plausible.io/js/plausible.js">
+  {% else %}
+<meta http-equiv="Content-Security-Policy" content="script-src 'self' https://{{site.customplausibleurl}}/js/index.js">
+  {% endif %}
+{% endif %}
+
+{% if site.unsafecontent == false %}
+<meta http-equiv="Content-Security-Policy" content="default-src 'self' https://*">
+{% else %}
+<meta http-equiv="Content-Security-Policy" content="script-src 'self'">
+{% endif %}

data/_includes/seo.html

@@ -0,0 +1,25 @@
+{% if site.lang != "" %}
+<meta http-equiv="language" content="{{site.lang}}">
+<meta property="og:locale" content="{{site.lang}}">
+{% endif %}
+{% if page.title == "" %}
+<title>{{site.title}}</title>
+<meta property="og:title" content="{{site.title}}">
+<meta name="twitter:title" content="{{site.title}}">
+{% else %}
+<title>{{ page.title }} - {{ site.title }}</title>
+<meta property="og:title" content="{{page.title}} - {{site.title}}">
+<meta name="twitter:title" content="{{page.title}} - {{site.title}}">
+{% endif %}
+{% if page.description == "" %}
+<meta name="description" content="{{site.description}}">
+<meta property="og:description" content="{{site.description}}">
+<meta property="twitter:description" content="{{site.description}}">
+{% else %}
+<meta name="description" content="{{page.description}}">
+<meta property="og:description" content="{{page.description}}">
+<meta property="twitter:description" content="{{page.description}}">
+{% endif %}
+{% if site.url != "" %}
+<link rel="canonical" href="{{site.url}}{{page.url|replace:'index.html',''}}">
+{% endif %}

data/_includes/site-sidebar.html

@@ -1,34 +1,34 @@
-<div class="sidebar">
-    <div>
-        <nav class="nav">
-            <a href="{{ '/' | relative_url }}"><h1 class="navLink" style="text-decoration: none !important;">{{ site.title }}</h1></a>
-            <ul class="links">
-                {% for item in site.navigation %}
-                    {% if item.url contains '://' %}
-                        {% assign url = item.url %}
-                    {% else %}
-                        {% assign url = item.url | relative_url %}
-                    {% endif %}
-                    <li> <a class="navLink" href="{{url}}">{{item.title}}</a> </li>
-                {% endfor %}
-            </ul>
-        </nav>
-        <div class="footer">
-            <p class="copyright">
-                &copy; {% if copyrightYear %}{{copyrightYear}}{% else %}{{ site.time | date: '%Y' }}{% endif %} {{ site.copyrightName }}.
-                <br />
-                {% if site.webSource %}
-                <a class="footerLink" href="{{site.webSource}}">Contribute to this site.</a><br />
-                {% endif %}
-                {% for item in site.footerLinks %}
-                    {% if item.url contains '://' %}
-                        {% assign url = item.url %}
-                    {% else %}
-                        {% assign url = item.url | relative_url %}
-                    {% endif %}
-                    <a href="{{url}}" class="footerLink">{{item.title}}</a>
-                {% endfor %}
-            </p>
-        </div>
-    </div>
+<div class="sidebar">
+    <div>
+        <nav>
+            <a href="{{ '/' | relative_url }}"><h1>{{ site.title }}</h1></a>
+            <ul>
+                {% for item in site.navigation %}
+                    {% if item.url contains '://' %}
+                        {% assign url = item.url %}
+                    {% else %}
+                        {% assign url = item.url | relative_url %}
+                    {% endif %}
+                    <li> <a href="{{url}}">{{item.title}}</a> </li>
+                {% endfor %}
+            </ul>
+        </nav>
+        <div class="footer">
+            <p>
+                &copy; {% if copyrightYear %}{{copyrightYear}}{% else %}{{ site.time | date: '%Y' }}{% endif %} {{ site.copyrightName }}.
+                <br />
+                {% if site.webSource %}
+                <a href="{{site.webSource}}">Contribute to this site.</a><br />
+                {% endif %}
+                {% for item in site.footerLinks %}
+                    {% if item.url contains '://' %}
+                        {% assign url = item.url %}
+                    {% else %}
+                        {% assign url = item.url | relative_url %}
+                    {% endif %}
+                    <a href="{{url}}">{{item.title}}</a>
+                {% endfor %}
+            </p>
+        </div>
+    </div>
 </div>

data/_includes/verifications.html

@@ -0,0 +1,30 @@
+{% if site.plingverify != "" %}
+  <meta name="ocs-site-verification" content="{{ site.plingverify }}">
+{% endif %}
+{% if site.googleverify != "" %}
+  <meta name="google-site-verification" content="{{ site.googleverify }}">
+{% endif %}
+{% if site.bingverify != "" %}
+  <meta name="msvalidate.01" content="{{ site.bingverify }}">
+{% endif %}
+{% if site.pinverify != "" %}
+  <meta name="p:domain_verify" content="{{ site.pinverify }}">
+{% endif %}
+{% if site.dailyverify != "" %}
+  <meta name="dailymotion-domain-verification" content="{{ site.dailyverify }}">
+{% endif %}
+{% if site.yandexverify != "" %}
+  <meta name="yandex-verification" content="{{ site.yandexverify }}">
+{% endif %}
+{% if site.nortonverify != "" %}
+  <meta name="norton-safeweb-site-verification" content="{{ site.nortonverify }}">
+{% endif %}
+{% if site.alexaverify != "" %}
+  <meta name="alexaVerifyID" content="{{ site.alexaverify }}">
+{% endif %}
+{% if site.wotverify != "" %}
+  <meta name="wot-verification" content="{{ site.wotverify }}">
+{% endif %}
+{% if site.specificverify != "" %}
+  <meta name="specificfeeds-verification-code" content="{{ site.specificverify }}">
+{% endif %}

data/_layouts/default.html

@@ -1,19 +1,26 @@
-<!DOCTYPE HTML>
-<html lang="{{site.lang}}">
-    <head>
-        <meta charset="utf-8" />
-        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
-        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-        <title>{{ page.title }} - {{ site.title }}</title>
-        <meta property="og:title" content="{{page.title}} - {{site.title}}" />
-        <meta name="description" content="{{page.description}}" />
-        <meta property="og:description" content="{{page.description}}" />
-        <link rel="stylesheet" href="{{ '/assets/main.css' | relative_url }}" />
-        {% if site.favicon %}
-            <link rel="shortcut icon" href="{{ site.favicon }}" />
-        {% endif %}
-    </head>
-    <body>
-        {{ content }}
-    </body>
+<!doctype html>{% if site.lang != "" %}
+<html lang="{{site.lang}}">
+{% else %}
+<html>
+{% endif %}
+  <head>
+    <meta charset="UTF-8">
+    {% include seo.html %}
+    <meta http-equiv="x-ua-compatible" content="ie=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="referrer" content="no-referrer, same-origin">
+    <link rel="canonical" href="{{ site.url }}{{ page.url | replace:'index.html',''}}">
+    {% if site.favicon != "" %}
+    <link rel="shortcut icon" href="{{ site.favicon }}">
+    <link rel="icon" href="{{site.favicon}}">
+    <link rel="apple-touch-icon" href="{{site.favicon}}">
+    {% endif %}
+    {% include verifications.html %}
+    {% include csp.html %}
+    {% include analytics.html %}
+    <link rel="stylesheet" href="{{ '/assets/main.css' | relative_url }}">
+  </head>
+  <body>
+    {{ content }}
+  </body>
 </html>

data/_layouts/page.html

@@ -1,9 +1,9 @@
----
-layout: default
----
-
-{% include site-sidebar.html %}
-
-<div class="container">
-    {{ content }}
+---
+layout: default
+---
+
+{% include site-sidebar.html %}
+
+<div class="container">
+    {{ content }}
 </div>

data/_sass/_config.scss

@@ -1,31 +1,31 @@
-// Main Colour
-$LIGHTbgColour: #fff;
-$DARKbgColour: #000;
-$accentColour: #f62c43;
-
-// Header Colours (also uses $accentColour)
-$headerTextColour: #000;
-
-// Navigation Colours
-$navColour: #000;
-$navHoverColour: #fff;
-
-// Text Colour
-$LIGHTtextColour: #000;
-$LIGHTlinkColour: #000;
-$LIGHTlinkHoverColour: #f62c43;
-$DARKtextColour: #fff;
-$DARKlinkColour: #fff;
-$DARKlinkHoverColour: #f62c43;
-$LIGHTnewsLinkColour: #f62c43;
-$DARKnewsLinkColour: #f62c43;
-
-// Typography & Misc.
-$font: 'Inter', sans-serif;
-$font-regular: 400;
-$font-bold: 700;
-$font-italic: italic;
-$breakColour: #fff;
-
-// Switch this to whatever font you need, local or remote
+// Main Colour
+$LIGHTbgColour: #fff;
+$DARKbgColour: #000;
+$accentColour: #f62c43;
+
+// Header Colours (also uses $accentColour)
+$headerTextColour: #000;
+
+// Navigation Colours
+$navColour: #000;
+$navHoverColour: #fff;
+
+// Text Colour
+$LIGHTtextColour: #000;
+$LIGHTlinkColour: #000;
+$LIGHTlinkHoverColour: #f62c43;
+$DARKtextColour: #fff;
+$DARKlinkColour: #fff;
+$DARKlinkHoverColour: #f62c43;
+$LIGHTnewsLinkColour: #f62c43;
+$DARKnewsLinkColour: #f62c43;
+
+// Typography & Misc.
+$font: 'Inter', sans-serif;
+$font-regular: 400;
+$font-bold: 700;
+$font-italic: italic;
+$breakColour: #fff;
+
+// Switch this to whatever font you need, local or remote
 @import url('https://rsms.me/inter/inter.css');

data/_sass/_theme.scss

@@ -1,104 +1,95 @@
-// Import configuration
-@charset "utf-8";
-@import "config";
-
-// Light and Dark Themes for Mobile
-@media (prefers-color-scheme: light) {
-    html {
-        background: $LIGHTbgColour;
-        color: $LIGHTtextColour;
-    }
-    a {
-        color: $LIGHTlinkColour;
-    }
-    a:hover {
-        color: $LIGHTlinkHoverColour;
-    }
-}
-
-@media screen and (max-height: 450px) {
-
-}
-
-html {
-    background: $DARKbgColour;
-    color: $DARKtextColour;
-}
-a {
-    color: $DARKlinkColour;
-}
-a:hover {
-    color: $DARKlinkHoverColour;
-}
-
-// Site Header (_includes/site-header.html)
-.sidebar {
-    height: 100%;
-    width: 240px;
-    position: fixed;
-    z-index: 1;
-    top: 0;
-    left: 0;
-    overflow-x: hidden;
-    padding: 20px 10px 10px 20px;
-    background: $accentColour;
-    color: $headerTextColour;
-    display: flex;
-    justify-content: center;
-    align-items: center;
-}
-
-.links {
-    list-style: none;
-}
-
-.navLink {
-    padding: .25em 1em 1em .25em;
-    text-decoration: none;
-    color: $navColour;
-}
-
-.navLink:hover { color: $navHoverColour; }
-
-.sidebar h1 {
-    font-weight: $font-bold;
-    font-size: 1.25em;
-    text-decoration: none;
-}
-
-.copyright {
-    font-size: .75em;
-    color: $navColour;
-}
-
-.footerLink {
-    text-decoration: underline;
-    color: $navColour;
-}
-
-.footerLink:hover { color: $navHoverColour; }
-
-.footer {
-    justify-content: left;
-    text-align: left;
-}
-
-// Typography and Misc.
-
-body {
-    font-family: $font;
-    font-weight: $font-regular;
-    font-size: 1.125em;
-    margin: -20px 0px 8px 0px;
-}
-
-.container {
-    margin-left: 240px;
-    padding: 1em 5em;
-    max-width: 40em;
-    display: block;
-}
-
-a { transition: color 500ms; text-decoration: none; }
-hr { color: $breakColour; }
-.bold { font-weight: $font-bold; }
+// Import configuration
+@charset "utf-8";
+@import "config";
+
+// Light and Dark Themes for Mobile
+@media (prefers-color-scheme: light) {
+  html {
+  background: $LIGHTbgColour;
+  color: $LIGHTtextColour;
+  }
+  a { color: $LIGHTlinkColour; }
+  a:hover { color: $LIGHTlinkHoverColour; }
+}
+
+@media (prefers-color-scheme: dark) {
+  html {
+  background: $DARKbgColour;
+  color: $DARKtextColour;
+  }
+  a { color: $DARKlinkColour; }
+  a:hover { color: $DARKlinkHoverColour; }
+
+}
+
+// Site Header (_includes/site-header.html)
+
+.sidebar {
+  height: 100%;
+  width: 35vw;
+  position: fixed;
+  z-index: 1;
+  top: 0;
+  left: 0;
+  overflow-x: hidden;
+  padding: 1vh 1vh 1vh 1vh;
+  background: $accentColour;
+  color: $headerTextColour;
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  max-width: 270px;
+  a {
+    text-decoration: none !important;
+    color: $navColour;
+  }
+  a:hover { color: $navHoverColour !important; }
+  nav {
+    ul {
+      padding: 1vh 1vh 1vh 1vh;
+      list-style: none;
+    }
+    h1 {
+      font-weight: $font-bold;
+      font-size: 1.25em;
+      text-decoration: none !important;
+    }
+  }
+}
+
+.footer {
+  justify-content: left;
+  text-align: left;
+  p {
+    font-size: .75em;
+    color: $navColour;
+  }
+}
+
+// Typography and Misc.
+
+body {
+  font-family: $font;
+  font-weight: $font-regular;
+  font-size: 1.125em;
+  margin: -20px 0px 8px 0px;
+}
+
+.container {
+  margin-left: 25vw;
+  padding: 1em 5em;
+  max-width: 65vw;
+  display: block;
+}
+
+a {
+  transition: color 250ms ease-in-out;
+  text-decoration: underline;
+}
+
+hr { color: $breakColour; }
+
+::selection {
+  background: $accentColour;
+  text-shadow: none;
+}