noir-for-jekyll 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea555c23968e1afb5aae03e0ed9c1c58ad6caab9159e8f46370980372219738a
-  data.tar.gz: 7503abe416c8f70694dfa3f0a6b1e61c4afe336f8c0db84b373611eb20d95e8a
+  metadata.gz: 4c40a33e5605818d5c6dda4ea67b99bbfdc744115f054a5d35fa6d71d39b4558
+  data.tar.gz: 9d4849b2e5f639251516595930b2848010bd644a395f2e2f7a9a7dd6eb3971bd
 SHA512:
-  metadata.gz: 4d5ca9dd19874c5a5cfdcb3ffcec48e652b2754ce688d8af8c357f753c02318590d71a01b4225358828905e202bc6451dc4b044423157acb221fdfc02f9621ac
-  data.tar.gz: 3b78615b1be436b43aa5458a0eaa99fe87797b85389092747c8cf0b263863edeaa92c3f5c28acf7b6e13eb14dec15afb269d9980968616645eb88b478c6cd13d
+  metadata.gz: 04c0d0fcc89184977eb2dd25eaf7d96201defd226833cb1d7d888d224af2f0d4b14389696a3a6b0264a4c6bd432fa25e7603dc2a7bed40ace5ebb268447f208e
+  data.tar.gz: 2214139498464f034dfe41cc3d709955db541dacb98047123eac5b955704d4beeb056586176a96b936d7d6453c6e5f415c98ed4b88ac48a59ecab8ea16897b3c

data/LICENSE.md

@@ -1,9 +1,9 @@
-# Released under MIT License
-
-Copyright (c) 2020 Victor Johnson.
-
-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.
-
+# Released under MIT License
+
+Copyright (c) 2020 Victor Johnson.
+
+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.

data/README.md

@@ -1,9 +1,21 @@
-# Released under MIT License
-
-Copyright (c) 2020 Victor Johnson.
-
-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.
+### Demo
+
+You can see a live demo of Noir: [https://noir.essentialenemy.com](https://noir.essentialenemy.com)
+
+### Installation
+
+First you will need to setup your Ruby environment and add the Jekyll and Bundler gems to it.
+
+Detailed instructions for getting Ruby setup can be found [here](https://www.ruby-lang.org/en/documentation/installation/) and the installation guide for Jekyll can be found [here](https://jekyllrb.com/docs/installation/). Bundler makes managing Jekyll sites a lot easier and you can learn how to install that gem [here](https://bundler.io) (this theme’s installation guide uses Bundler).
+
+Once that’s done it’s time for the fun part. Don’t even bother with the `jekyll new site` command, I am going to provide a more foolproof way so that you don’t wind up in dependencies hell.
+
+1. Download the [zip archive](https://github.com/essentialenemy/noir/archive/master.zip) of this repository and copy the files into a new directory where you want your site’s configuration files to live.
+2. In your terminal or command prompt `cd` into the new directory you just made for those files.
+3. Run the command: `bundle install` as this will install all of the dependencies I have named in `Gemfile.lock`.
+4. Test that the site can be built with no issues, run the command: `bundle exec jekyll serve` and view the site by navigating to `127.0.0.1:4000` in your web browser.
+5. If all is working fine you can begin customizing your site by making changes to `_config.yml`.
+
+If you have any problems that arise I am glad to help you as much as I can. You can open a [new issue](https://github.com/essentialenemy/noir/issues), reach out to me on [Twitter](https://twitter.com/essentialenemy) or email me at the address found inside of `_config.yml`. I welcome your feedback and requests as well.
+
+Thank you for your interest in Noir!

data/_includes/head.html

@@ -1,19 +1,19 @@
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-  <title>
-    {% if page.title == "Home" %}
-      {{ site.title }}{% if site.tagline %} &middot; {{ site.tagline }}{% endif %}
-    {% else %}
-      {{ page.title }} &middot; {{ site.title }}
-    {% endif %}
-  </title>
-
-  <link rel="stylesheet" href="{{ site.baseurl }}/styles.css">
-  <link rel="apple-touch-icon-precomposed" sizes="144x144" href="{{ site.baseurl }}/assets/apple-touch-icon-precomposed.png">
-  <link rel="shortcut icon" href="{{ site.baseurl }}/assets/favicon.ico">
-  <link rel="alternate" type="application/atom+xml" title="{{ site.title }}" href="{{ site.baseurl }}/atom.xml">
-
-  {% seo title=false %}
-</head>
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <title>
+    {% if page.title == "Home" %}
+      {{ site.title }}{% if site.tagline %} &middot; {{ site.tagline }}{% endif %}
+    {% else %}
+      {{ page.title }} &middot; {{ site.title }}
+    {% endif %}
+  </title>
+
+  <link rel="stylesheet" href="{{ site.baseurl }}/styles.css">
+  <link rel="apple-touch-icon-precomposed" sizes="144x144" href="{{ site.baseurl }}/assets/apple-touch-icon-precomposed.png">
+  <link rel="shortcut icon" href="{{ site.baseurl }}/assets/favicon.ico">
+  <link rel="alternate" type="application/atom+xml" title="{{ site.title }}" href="{{ site.baseurl }}/atom.xml">
+
+  {% seo title=false %}
+</head>

data/_layouts/default.html

@@ -1,38 +1,38 @@
-<!doctype html>
-<html lang="en">
-
-  {% include head.html %}
-
-  <body>
-
-    <div class="container content">
-      <header class="masthead">
-        <h3 class="masthead-title">
-          <a href="{{ site.baseurl }}/" title="Home">{{ site.title }}</a>
-          <small>{{ site.tagline }}</small>
-        </h3>
-      </header>
-
-      <main>
-        {{ content }}
-      </main>
-
-      <footer class="footer">
-        <small>
-          Copyright &copy; <time datetime="{{ site.time | date_to_xmlschema }}">{{ site.time | date: '%Y' }}</time>. Change this text in _layouts/default.html
-        </small>
-      </footer>
-    </div>
-
-    {% if site.ga_analytics %}
-     <script>
-       (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-       (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
-       m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-       })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
-       ga('create', '{{ site.ga_analytics }}', 'auto');
-       ga('send', 'pageview');
-     </script>
-    {% endif %}
-  </body>
-</html>
+<!doctype html>
+<html lang="en">
+
+  {% include head.html %}
+
+  <body>
+
+    <div class="container content">
+      <header class="masthead">
+        <h3 class="masthead-title">
+          <a href="{{ site.baseurl }}/" title="Home">{{ site.title }}</a>
+          <small>{{ site.tagline }}</small>
+        </h3>
+      </header>
+
+      <main>
+        {{ content }}
+      </main>
+
+      <footer class="footer">
+        <small>
+          Copyright &copy; <time datetime="{{ site.time | date_to_xmlschema }}">{{ site.time | date: '%Y' }}</time>. Change this text in _layouts/default.html
+        </small>
+      </footer>
+    </div>
+
+    {% if site.ga_analytics %}
+     <script>
+       (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+       (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+       m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+       })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+       ga('create', '{{ site.ga_analytics }}', 'auto');
+       ga('send', 'pageview');
+     </script>
+    {% endif %}
+  </body>
+</html>

data/_layouts/page.html

@@ -1,8 +1,8 @@
----
-layout: default
----
-
-<article class="page">
-  <h1 class="page-title">{{ page.title }}</h1>
-  {{ content }}
-</article>
+---
+layout: default
+---
+
+<article class="page">
+  <h1 class="page-title">{{ page.title }}</h1>
+  {{ content }}
+</article>

data/_layouts/post.html

@@ -1,25 +1,25 @@
----
-layout: default
----
-
-<article class="post">
-  <h1 class="post-title">{{ page.title }}</h1>
-  <time datetime="{{ page.date | date_to_xmlschema }}" class="post-date">{{ page.date | date_to_string }}</time>
-  {{ content }}
-</article>
-
-{% if site.related_posts != empty %}
-<aside class="related">
-  <h3>Related posts</h3>
-  <ul class="related-posts">
-    {% for post in site.related_posts limit:3 %}
-      <li>
-        <a href="{{ site.baseurl }}{{ post.url }}">
-          {{ post.title }}
-          <small><time datetime="{{ post.date | date_to_xmlschema }}">{{ post.date | date_to_string }}</time></small>
-        </a>
-      </li>
-    {% endfor %}
-  </ul>
-</aside>
-{% endif %}
+---
+layout: default
+---
+
+<article class="post">
+  <h1 class="post-title">{{ page.title }}</h1>
+  <time datetime="{{ page.date | date_to_xmlschema }}" class="post-date">{{ page.date | date_to_string }}</time>
+  {{ content }}
+</article>
+
+{% if site.related_posts != empty %}
+<aside class="related">
+  <h3>Related posts</h3>
+  <ul class="related-posts">
+    {% for post in site.related_posts limit:3 %}
+      <li>
+        <a href="{{ site.baseurl }}{{ post.url }}">
+          {{ post.title }}
+          <small><time datetime="{{ post.date | date_to_xmlschema }}">{{ post.date | date_to_string }}</time></small>
+        </a>
+      </li>
+    {% endfor %}
+  </ul>
+</aside>
+{% endif %}

data/_sass/_base.scss

@@ -1,91 +1,91 @@
-// Body resets
-//
-// Update the foundational and global aspects of the page.
-
-* {
-  -webkit-box-sizing: border-box;
-     -moz-box-sizing: border-box;
-          box-sizing: border-box;
-}
-
-html,
-body {
-  margin: 0;
-  padding: 0;
-}
-
-html {
-  font-family: $root-font-family;
-  font-size: $root-font-size;
-  line-height: $root-line-height;
-
-  @media (min-width: $large-breakpoint) {
-    font-size: $large-font-size;
-  }
-}
-
-body {
-  color: $body-color;
-  background-color: $body-bg;
-  -webkit-text-size-adjust: 100%;
-      -ms-text-size-adjust: 100%;
-	  
-@media (prefers-color-scheme: dark) {
-  color: $body-color-dark;
-  background-color: $body-bg-dark;
-  }
-}
-
-// No `:visited` state is required by default (browsers will use `a`)
-a {
-  color: $link-color;
-  text-decoration: none;
-
-  // `:focus` is linked to `:hover` for basic accessibility
-  &:hover,
-  &:focus {
-    text-decoration: underline;
-  }
-
-  strong {
-    color: inherit;
-  }
-}
-
-img {
-  display: block;
-  max-width: 100%;
-  margin: 0 0 1rem;
-  border-radius: 5px;
-}
-
-table {
-  margin-bottom: 1rem;
-  width: 100%;
-  font-size: 85%;
-  border: 1px solid #e5e5e5;
-  border-collapse: collapse;
-}
-
-td,
-th {
-  padding: .25rem .5rem;
-  border: 1px solid #e5e5e5;
-  
-@media (prefers-color-scheme: dark) {
-  border: 1px solid #898989;
-  }
-}
-
-th {
-  text-align: left;
-}
-
-tbody tr:nth-child(odd) td,
-tbody tr:nth-child(odd) th {
-  background-color: #f9f9f9;
-
-@media (prefers-color-scheme: dark) {
-  background-color: #2d2d2d;
-  }
-}
+// Body resets
+//
+// Update the foundational and global aspects of the page.
+
+* {
+  -webkit-box-sizing: border-box;
+     -moz-box-sizing: border-box;
+          box-sizing: border-box;
+}
+
+html,
+body {
+  margin: 0;
+  padding: 0;
+}
+
+html {
+  font-family: $root-font-family;
+  font-size: $root-font-size;
+  line-height: $root-line-height;
+
+  @media (min-width: $large-breakpoint) {
+    font-size: $large-font-size;
+  }
+}
+
+body {
+  color: $body-color;
+  background-color: $body-bg;
+  -webkit-text-size-adjust: 100%;
+      -ms-text-size-adjust: 100%;
+	  
+@media (prefers-color-scheme: dark) {
+  color: $body-color-dark;
+  background-color: $body-bg-dark;
+  }
+}
+
+// No `:visited` state is required by default (browsers will use `a`)
+a {
+  color: $link-color;
+  text-decoration: none;
+
+  // `:focus` is linked to `:hover` for basic accessibility
+  &:hover,
+  &:focus {
+    text-decoration: underline;
+  }
+
+  strong {
+    color: inherit;
+  }
+}
+
+img {
+  display: block;
+  max-width: 100%;
+  margin: 0 0 1rem;
+  border-radius: 5px;
+}
+
+table {
+  margin-bottom: 1rem;
+  width: 100%;
+  font-size: 85%;
+  border: 1px solid $border-color;
+  border-collapse: collapse;
+}
+
+td,
+th {
+  padding: .25rem .5rem;
+  border: 1px solid $border-color;
+  
+@media (prefers-color-scheme: dark) {
+  border: 1px solid $gray-9;
+  }
+}
+
+th {
+  text-align: left;
+}
+
+tbody tr:nth-child(odd) td,
+tbody tr:nth-child(odd) th {
+  background-color: $gray-1;
+
+@media (prefers-color-scheme: dark) {
+  background-color: #2d2d2d;
+  }
+}

data/_sass/_code.scss

@@ -1,76 +1,75 @@
-// Code
-//
-// Inline and block-level code snippets. Includes tweaks to syntax highlighted
-// snippets from Pygments/Rouge and Gist embeds.
-
-code,
-pre {
-  font-family: $code-font-family;
-}
-
-code {
-  font-size: 70%;
-}
-
-pre {
-  display: block;
-  margin-top: 0;
-  margin-bottom: 1rem;
-  overflow: auto;
-}
-  
-.highlighter-rouge {
-	padding: 3px 4px;
-    border: 1px solid #1ba77e;
-    border-radius: 6px;
-    background-color: #eee;
-    color: #1ba77e;
-	white-space: nowrap;
-	font-size: 85%;
-	
-@media (prefers-color-scheme: dark) {
-    background-color: #202020;
-    color: #1ba77e;
-	}
-
-.highlight {
-  padding: 1rem;
-  margin-bottom: 1rem;
-  background-color: #f9f9f9;
-  border-radius: .25rem;
-
-  pre {
-    margin-bottom: 0;
-  }
-}
-
-  // Triple backticks (code fencing) doubles the .highlight elements
-  .highlight {
-    padding: 0;
-  }
-}
-
-.rouge-table {
-  margin-bottom: 0;
-  font-size: 100%;
-
-  &,
-  td,
-  th {
-    border: 0;
-  }
-
-  .gutter {
-    color: rgba(0,0,0,.25);
-    vertical-align: top;
-    // Make sure numbers aren't selectable
-    -webkit-user-select: none;
-        -ms-user-select: none;
-            user-select: none;
-  }
-}
-
-// Gist via GitHub Pages
-.gist .markdown-body {
-  padding: 15px !important;
-}
+// Code
+//
+// Inline and block-level code snippets. Includes tweaks to syntax highlighted
+// snippets from Pygments/Rouge and Gist embeds.
+
+code,
+pre {
+  font-family: $code-font-family;
+}
+
+code {
+  font-size: 70%;
+}
+
+pre {
+  display: block;
+  margin-top: 0;
+  margin-bottom: 1rem;
+  overflow: auto;
+}
+  
+.highlighter-rouge {
+	padding: 3px 4px;
+    border: 1px solid $green;
+    border-radius: 6px;
+    background-color: #eee;
+    color: $green;
+	white-space: nowrap;
+	font-size: 85%;
+	
+@media (prefers-color-scheme: dark) {
+    background-color: #202020;
+	}
+
+.highlight {
+  padding: 1rem;
+  margin-bottom: 1rem;
+  background-color: $gray-1;
+  border-radius: .25rem;
+
+  pre {
+    margin-bottom: 0;
+  }
+}
+
+  // Triple backticks (code fencing) doubles the .highlight elements
+  .highlight {
+    padding: 0;
+  }
+}
+
+.rouge-table {
+  margin-bottom: 0;
+  font-size: 100%;
+
+  &,
+  td,
+  th {
+    border: 0;
+  }
+
+  .gutter {
+    color: rgba(0,0,0,.25);
+    vertical-align: top;
+    // Make sure numbers aren't selectable
+    -webkit-user-select: none;
+        -ms-user-select: none;
+            user-select: none;
+  }
+}
+
+// Gist via GitHub Pages
+.gist .markdown-body {
+  padding: 15px !important;
+}