jekyll-theme-console 0.3.7 → 0.3.8

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c66b8218558161259f34ad1619ca01875fdf665d65e22f2323d2ac8f6cfa9328
4
- data.tar.gz: 648e4487fb1343b3af01bc34dc1831443ce72b985a7b4e6b6bfbe98f11030e26
3
+ metadata.gz: 0d8199be043bdc2145d7e1101fb983d2b0d95043e5cb5f365d534f8c0f8c6cf4
4
+ data.tar.gz: 5b5e30ea1aa790ae3d00805fbc1a0fbaa4b65390b0db82d4e9e36caf42720a17
5
5
  SHA512:
6
- metadata.gz: 1314495ed2e4816d93da0393b230805938471fc9613975eb434b95ee61e61522430f6f795ae518127afc1133f36e9985361a1726b4b9dcd186a503c0788e5461
7
- data.tar.gz: 81fb61d18089cc0ab07816ef618eb1b512f04cf5ec564b0e9cff83d5ece9cd0370d821fe6adce6eae8a085acac8987887ed3e85ce9e12a026834d78ae0944ed5
6
+ metadata.gz: ed26b0d2da4bdc81ed6c3bc3629e7fa2250ffef74e131839117440aae0de87b5211eb6b465af0d67d5eb142131e511a6d40190d04f18a979b8a7a95d91ce177f
7
+ data.tar.gz: 64c7f1ab473960237b744bab328e52e92387f9e2686dc1172f25c98ea69b315af260d4ced7ebc5c3099e322ab3938b002c9b4af119c0d1e23d5ac229e4860ae5
data/README.md CHANGED
@@ -13,47 +13,75 @@ source code: [https://github.com/b2a3e8/jekyll-theme-console/tree/gh-pages](http
13
13
 
14
14
  ## Installation
15
15
 
16
- Add this line to your Jekyll site's `Gemfile`:
16
+ 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.
17
17
 
18
- ```ruby
19
- gem "jekyll-theme-console"
20
- ```
18
+ ### Remote theme method for GitHub Pages
21
19
 
22
- And add this line to your Jekyll site's `_config.yml`:
20
+ Use this method for sites hosted with GitHub Pages only. To install:
23
21
 
24
- ```yaml
25
- theme: jekyll-theme-console
26
- ```
22
+ 1. Set `remote_theme` in your project's Jekyll `_config.yml` file:
23
+
24
+ ```yaml
25
+ remote_theme: b2a3e8/jekyll-theme-console
26
+ ```
27
+
28
+ ### Gem-based method
29
+
30
+ 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.
31
+
32
+ This allows for easier installation and updating as you don't have to manage any of the theme files. To install:
27
33
 
28
- And then execute:
34
+ 1. Add this line to your Jekyll site's `Gemfile`:
29
35
 
30
- $ bundle
36
+ ```ruby
37
+ gem "jekyll-theme-console"
38
+ ```
31
39
 
32
- Or install it yourself as:
40
+ 2. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command:
33
41
 
34
- $ gem install jekyll-theme-console
42
+ ```bash
43
+ bundle
44
+ ```
45
+
46
+ 3. Set `theme` in your project's Jekyll `_config.yml` file:
47
+
48
+ ```yaml
49
+ theme: jekyll-theme-console
50
+ ```
51
+
52
+ To update the theme run `bundle update`.
35
53
 
36
54
  ## Usage
37
55
 
56
+ ### _config.yaml
57
+
38
58
  In addition to jekyll's default configuration options, you can provide:
39
59
  - `header_pages` to specify which pages should be displayed in navbar
40
60
  - `footer` string, which will be inserted on the end of the page (doesn't support markup, but html)
41
- - `google_analytics` tracking id (tracking will be enabled only in production environments)
42
- - `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)
61
+ - `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)
62
+ - `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)
63
+ - `style` to specify which predefined style (colors) should be used
43
64
 
44
65
  ```yaml
45
66
  header_pages:
46
67
  - index.md
47
68
  - about.md
48
69
 
49
- style: dark # dark (default) or light
50
- listen_for_clients_preferred_style: true # true or false (default)
70
+ style: dark # dark (default), light or hacker
71
+ listen_for_clients_preferred_style: true # false (default) or true
51
72
 
52
73
  footer: 'follow us on <a href="https://twitter.com/xxx">twitter</a>'
53
74
 
54
75
  google_analytics: UA-NNNNNNNN-N
55
76
  ```
56
77
 
78
+ ### front matter variables
79
+
80
+ Besides the predefined [front matter](https://jekyllrb.com/docs/front-matter/) variables from jekyll this theme also supports following variables:
81
+ - `title` to set a title for the page
82
+ - `lang` to specify the language, defaults to 'en'
83
+ - `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
84
+
57
85
  ## Customization
58
86
 
59
87
  If you want to customize this theme, follow this steps:
@@ -5,12 +5,18 @@
5
5
  <title>{{ page.title }}</title>
6
6
  {%- seo title=false -%}
7
7
 
8
+ {% if page.robots %}
9
+ <meta name="robots" content="{{page.robots}}" />
10
+ {% endif %}
11
+
8
12
  {%- if site.listen_for_clients_preferred_style -%}
9
13
  <link rel="stylesheet" type="text/css" href="{{ "/assets/main.css" | relative_url }}">
10
14
  {%- else -%}
11
15
  {%- if site.style == 'light' -%}
12
- <link rel="stylesheet" type="text/css" href="{{ "/assets/main-light.css" | relative_url }}">
13
- {%- else -%}
16
+ <link rel="stylesheet" type="text/css" href="{{ "/assets/main-light.css" | relative_url }}">
17
+ {%- elsif site.style == 'hacker' -%}
18
+ <link rel="stylesheet" type="text/css" href="{{ "/assets/main-hacker.css" | relative_url }}">
19
+ {%- else -%}
14
20
  <link rel="stylesheet" type="text/css" href="{{ "/assets/main-dark.css" | relative_url }}">
15
21
  {%- endif -%}
16
22
  {%- endif -%}
@@ -4,7 +4,6 @@
4
4
 
5
5
  :root {
6
6
  --base-color: #DBDBDB;
7
- --primary-color: #A2FC8F;
8
7
  --border: dashed 1px rgba(219, 219, 219, 0.9);
9
8
  --selection-background: rgba(219, 219, 219, 0.99);
10
9
  --selection-text: #000;
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Hacker theme variables
3
+ */
4
+
5
+ :root {
6
+ --base-color: #00ff00;
7
+ --border: dashed 1px rgba(0, 255, 0, 0.9);
8
+ --selection-background: rgba(0, 255, 0, 0.99);
9
+ --selection-text: #000;
10
+ --background-color: #000;
11
+ --text-color: var(--base-color);
12
+ --placeholder-color: var(--base-color);
13
+ --link-color: var(--base-color);
14
+ --code-color-1: #aaaaaa;
15
+ --code-color-2: #ffffcc;
16
+ --code-color-3: #F00000;
17
+ --code-color-4: #F0A0A0;
18
+ --code-color-5: #b38aff;
19
+ --code-color-6: #5ba711;
20
+ --code-color-7: #e4e477;
21
+ --code-color-8: #000080;
22
+ --code-color-9: #05ca05;
23
+ --code-color-10: #888888;
24
+ --code-color-11: #555555;
25
+ --code-color-12: #800080;
26
+ --code-color-13: #00d4d4;
27
+ --code-color-14: #00c1c1;
28
+ --code-color-15: #ed9d13;
29
+ --code-color-16: #1e90ff;
30
+ --code-color-17: #800000;
31
+ --code-color-18: #bbbbbb;
32
+ }
@@ -4,7 +4,6 @@
4
4
 
5
5
  :root {
6
6
  --base-color: #000;
7
- --primary-color: #0000EE;
8
7
  --border: dashed 1px rgba(0, 0, 0, 1);
9
8
  --selection-background: rgba(0, 0, 0, 0.99);
10
9
  --selection-text: #FFF;
@@ -19,7 +19,6 @@ h1, h2, h3, h4, h5, h6 { font-size: $base-font-size; margin: 0px; margin-top:
19
19
  p, ul, ol { margin: 0px; color: var(--text-color); }
20
20
  a { text-decoration: underline; color: var(--link-color); }
21
21
  a:hover { color: var(--background-color); background-color: var(--base-color); }
22
- .primary-text { color: var(--primary-color); }
23
22
  @media only screen and (max-device-width: 500px) { * { font-size: $mobile-font-size !important; } }
24
23
  /*h1:before { content: "#"; margin-right: 9px; }
25
24
  h2:before { content: "##"; margin-right: 9px; }
@@ -0,0 +1,6 @@
1
+ ---
2
+ # Only the main Sass file needs front matter (the dashes are enough)
3
+ ---
4
+
5
+ @import "hacker";
6
+ @import "base";
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-console
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.7
4
+ version: 0.3.8
5
5
  platform: ruby
6
6
  authors:
7
7
  - b2a3e8
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-11-06 00:00:00.000000000 Z
11
+ date: 2020-06-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -84,9 +84,11 @@ files:
84
84
  - _layouts/page.html
85
85
  - _layouts/post.html
86
86
  - _sass/_dark.scss
87
+ - _sass/_hacker.scss
87
88
  - _sass/_light.scss
88
89
  - _sass/base.scss
89
90
  - assets/main-dark.scss
91
+ - assets/main-hacker.scss
90
92
  - assets/main-light.scss
91
93
  - assets/main.scss
92
94
  homepage: https://github.com/b2a3e8/jekyll-theme-console