jekyll-theme-console 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c66b8218558161259f34ad1619ca01875fdf665d65e22f2323d2ac8f6cfa9328
-  data.tar.gz: 648e4487fb1343b3af01bc34dc1831443ce72b985a7b4e6b6bfbe98f11030e26
+  metadata.gz: 0d8199be043bdc2145d7e1101fb983d2b0d95043e5cb5f365d534f8c0f8c6cf4
+  data.tar.gz: 5b5e30ea1aa790ae3d00805fbc1a0fbaa4b65390b0db82d4e9e36caf42720a17
 SHA512:
-  metadata.gz: 1314495ed2e4816d93da0393b230805938471fc9613975eb434b95ee61e61522430f6f795ae518127afc1133f36e9985361a1726b4b9dcd186a503c0788e5461
-  data.tar.gz: 81fb61d18089cc0ab07816ef618eb1b512f04cf5ec564b0e9cff83d5ece9cd0370d821fe6adce6eae8a085acac8987887ed3e85ce9e12a026834d78ae0944ed5
+  metadata.gz: ed26b0d2da4bdc81ed6c3bc3629e7fa2250ffef74e131839117440aae0de87b5211eb6b465af0d67d5eb142131e511a6d40190d04f18a979b8a7a95d91ce177f
+  data.tar.gz: 64c7f1ab473960237b744bab328e52e92387f9e2686dc1172f25c98ea69b315af260d4ced7ebc5c3099e322ab3938b002c9b4af119c0d1e23d5ac229e4860ae5

data/README.md

@@ -13,47 +13,75 @@ source code: [https://github.com/b2a3e8/jekyll-theme-console/tree/gh-pages](http
 
 ## Installation
 
-Add this line to your Jekyll site's `Gemfile`:
+First, follow the steps in [this Quickstart Guide](https://jekyllrb.com/docs/) if you're starting with Jekyll from scratch. Skip this if you already have an existing jekyll project.
 
-```ruby
-gem "jekyll-theme-console"
-```
+### Remote theme method for GitHub Pages
 
-And add this line to your Jekyll site's `_config.yml`:
+Use this method for sites hosted with GitHub Pages only. To install:
 
-```yaml
-theme: jekyll-theme-console
-```
+1. Set `remote_theme` in your project's Jekyll `_config.yml` file:
+
+   ```yaml
+   remote_theme: b2a3e8/jekyll-theme-console
+   ```
+
+### Gem-based method
+
+With Gem-based themes, directories such as the `assets`, `_layouts`, `_includes`, and `_sass` are stored in the theme’s gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll’s build process.
+
+This allows for easier installation and updating as you don't have to manage any of the theme files. To install:
 
-And then execute:
+1. Add this line to your Jekyll site's `Gemfile`:
 
-    $ bundle
+   ```ruby
+   gem "jekyll-theme-console"
+   ```
 
-Or install it yourself as:
+2. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command:
 
-    $ gem install jekyll-theme-console
+   ```bash
+   bundle
+   ```
+
+3. Set `theme` in your project's Jekyll `_config.yml` file:
+
+   ```yaml
+   theme: jekyll-theme-console
+   ```
+
+To update the theme run `bundle update`.
 
 ## Usage
 
+### _config.yaml
+
 In addition to jekyll's default configuration options, you can provide:
 - `header_pages` to specify which pages should be displayed in navbar
 - `footer` string, which will be inserted on the end of the page (doesn't support markup, but html)
-- `google_analytics` tracking id (tracking will be enabled only in production environments)
-- `listen_for_clients_preferred_style` boolean, used to allow users to choose theme based on their preferences (mostly affected by OS dark or light theme, details see https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
+- `google_analytics` tracking id (tracking will be enabled only in production environments and only if you set this option, no Google Analytics code will be loaded if you don't set this option)
+- `listen_for_clients_preferred_style` boolean, used to allow users to choose light or dark style based on their preferences (mostly affected by OS dark or light theme, details see https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
+- `style` to specify which predefined style (colors) should be used
 
 ```yaml
 header_pages:
   - index.md
   - about.md
 
-style: dark # dark (default) or light
-listen_for_clients_preferred_style: true # true or false (default)
+style: dark # dark (default), light or hacker
+listen_for_clients_preferred_style: true # false (default) or true
 
 footer: 'follow us on <a href="https://twitter.com/xxx">twitter</a>'
 
 google_analytics: UA-NNNNNNNN-N
 ```
 
+### front matter variables
+
+Besides the predefined [front matter](https://jekyllrb.com/docs/front-matter/) variables from jekyll this theme also supports following variables:
+- `title` to set a title for the page
+- `lang` to specify the language, defaults to 'en'
+- `robots` to control the robot meta tag ([details](http://longqian.me/2017/02/12/jekyll-robots-configuration/)) - this may be useful for example to set `NOINDEX` to tag pages
+
 ## Customization
 
 If you want to customize this theme, follow this steps:

data/_includes/head.html

@@ -5,12 +5,18 @@
   <title>{{ page.title }}</title>
   {%- seo title=false -%}
 
+  {% if page.robots %}
+    <meta name="robots" content="{{page.robots}}" />
+  {% endif %}
+
   {%- if site.listen_for_clients_preferred_style -%}
     <link rel="stylesheet" type="text/css" href="{{ "/assets/main.css" | relative_url }}">
   {%- else -%}
     {%- if site.style == 'light' -%}
-     <link rel="stylesheet" type="text/css" href="{{ "/assets/main-light.css" | relative_url }}">
-   {%- else -%}
+      <link rel="stylesheet" type="text/css" href="{{ "/assets/main-light.css" | relative_url }}">
+    {%- elsif site.style == 'hacker' -%}
+      <link rel="stylesheet" type="text/css" href="{{ "/assets/main-hacker.css" | relative_url }}">
+    {%- else -%}
       <link rel="stylesheet" type="text/css" href="{{ "/assets/main-dark.css" | relative_url }}">
     {%- endif -%}
   {%- endif -%}

data/_sass/_dark.scss

@@ -4,7 +4,6 @@
 
 :root {
   --base-color: #DBDBDB;
-  --primary-color: #A2FC8F;
   --border: dashed 1px rgba(219, 219, 219, 0.9);
   --selection-background: rgba(219, 219, 219, 0.99);
   --selection-text: #000;

data/_sass/_hacker.scss

@@ -0,0 +1,32 @@
+/**
+ * Hacker theme variables
+ */
+
+:root {
+  --base-color: #00ff00;
+  --border: dashed 1px rgba(0, 255, 0, 0.9);
+  --selection-background: rgba(0, 255, 0, 0.99);
+  --selection-text: #000;
+  --background-color: #000;
+  --text-color: var(--base-color);
+  --placeholder-color: var(--base-color);
+  --link-color: var(--base-color);
+  --code-color-1: #aaaaaa;
+  --code-color-2: #ffffcc;
+  --code-color-3: #F00000;
+  --code-color-4: #F0A0A0;
+  --code-color-5: #b38aff;
+  --code-color-6: #5ba711;
+  --code-color-7: #e4e477;
+  --code-color-8: #000080;
+  --code-color-9: #05ca05;
+  --code-color-10: #888888;
+  --code-color-11: #555555;
+  --code-color-12: #800080;
+  --code-color-13: #00d4d4;
+  --code-color-14: #00c1c1;
+  --code-color-15: #ed9d13;
+  --code-color-16: #1e90ff;
+  --code-color-17: #800000;
+  --code-color-18: #bbbbbb;
+}

data/_sass/_light.scss

@@ -4,7 +4,6 @@
 
 :root {
   --base-color: #000;
-  --primary-color: #0000EE;
   --border: dashed 1px rgba(0, 0, 0, 1);
   --selection-background: rgba(0, 0, 0, 0.99);
   --selection-text: #FFF;

data/_sass/base.scss

@@ -19,7 +19,6 @@ h1, h2, h3, h4, h5, h6 { font-size: $base-font-size;  margin: 0px;  margin-top:
 p, ul, ol { margin: 0px;  color: var(--text-color); }
 a { text-decoration: underline;  color: var(--link-color); }
 a:hover { color: var(--background-color); background-color: var(--base-color); }
-.primary-text { color: var(--primary-color); }
 @media only screen and (max-device-width: 500px) { * { font-size: $mobile-font-size !important; } }
 /*h1:before { content: "#";  margin-right: 9px; }
 h2:before { content: "##";  margin-right: 9px; }

data/assets/main-hacker.scss

@@ -0,0 +1,6 @@
+---
+# Only the main Sass file needs front matter (the dashes are enough)
+---
+
+@import "hacker";
+@import "base";

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-console
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - b2a3e8
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -84,9 +84,11 @@ files:
 - _layouts/page.html
 - _layouts/post.html
 - _sass/_dark.scss
+- _sass/_hacker.scss
 - _sass/_light.scss
 - _sass/base.scss
 - assets/main-dark.scss
+- assets/main-hacker.scss
 - assets/main-light.scss
 - assets/main.scss
 homepage: https://github.com/b2a3e8/jekyll-theme-console