jekyll-theme-console 0.3.7 → 0.3.12
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +58 -18
- data/_includes/head.html +8 -2
- data/_sass/_dark.scss +0 -1
- data/_sass/_hacker.scss +32 -0
- data/_sass/_light.scss +0 -1
- data/_sass/base.scss +1 -8
- data/assets/main-hacker.scss +6 -0
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ad129b5ca2e4f4fe463a78fa60f29755be92763a72a639b834a040d1fbf01457
|
4
|
+
data.tar.gz: 22e5dbf9aeef41821b9d0e9a7d031b5c68ef2a74d030bfa269b9bcf4ddc68de9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 26bc9db66ed4e1a144fcfad99167208968bcd6961818039e11638f6dc839bc9b99b6f6fc69639367f92c1662f68901b754d47fcd41bdb694b095b7ff9bd3ddb5
|
7
|
+
data.tar.gz: 4e8fc1f8a38c3d8c479bc84676016f609a096f8aa1e93e7953cd03affba74c1e857c43bf68da2ca5b0ab77a8da2fcdc7bd7e9c494055cb2c0a978dbff6347bf1
|
data/README.md
CHANGED
@@ -6,54 +6,94 @@ A jekyll theme with inspiration from linux consoles for hackers, developers and
|
|
6
6
|
|
7
7
|
## Demo
|
8
8
|
|
9
|
-
[https://b2a3e8.github.io/jekyll-theme-console/](https://
|
9
|
+
[dark style](https://b2a3e8.github.io/jekyll-theme-console-demo-dark/) ([source code](https://github.com/b2a3e8/jekyll-theme-console-demo-dark)):
|
10
10
|
|
11
|
-
|
11
|
+
[<img src="https://raw.githubusercontent.com/b2a3e8/jekyll-theme-console/master/screenshot-dark.png" width="350" title="Screenshot">](https://b2a3e8.github.io/jekyll-theme-console-demo-dark/)
|
12
|
+
|
13
|
+
|
14
|
+
[light style](https://b2a3e8.github.io/jekyll-theme-console-demo-light/) ([source code](https://github.com/b2a3e8/jekyll-theme-console-demo-light)):
|
15
|
+
|
16
|
+
[<img src="https://raw.githubusercontent.com/b2a3e8/jekyll-theme-console/master/screenshot-light.png" width="350" title="Screenshot">](https://b2a3e8.github.io/jekyll-theme-console-demo-light/)
|
17
|
+
|
18
|
+
|
19
|
+
[hacker style](https://b2a3e8.github.io/jekyll-theme-console-demo-hacker/) ([source code](https://github.com/b2a3e8/jekyll-theme-console-demo-hacker)):
|
20
|
+
|
21
|
+
[<img src="https://raw.githubusercontent.com/b2a3e8/jekyll-theme-console/master/screenshot-hacker.png" width="350" title="Screenshot">](https://b2a3e8.github.io/jekyll-theme-console-demo-hacker/)
|
12
22
|
|
13
23
|
|
14
24
|
## Installation
|
15
25
|
|
16
|
-
|
26
|
+
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
27
|
|
18
|
-
|
19
|
-
gem "jekyll-theme-console"
|
20
|
-
```
|
28
|
+
**_You can also use the [demo site's source code](https://b2a3e8.github.io/jekyll-theme-console-demo-dark/) as template for an easy start._**
|
21
29
|
|
22
|
-
|
30
|
+
### Remote theme method for GitHub Pages
|
23
31
|
|
24
|
-
|
25
|
-
|
26
|
-
|
32
|
+
Use this method for sites hosted with GitHub Pages only. To install:
|
33
|
+
|
34
|
+
1. Set `remote_theme` in your project's Jekyll `_config.yml` file:
|
27
35
|
|
28
|
-
|
36
|
+
```yaml
|
37
|
+
remote_theme: b2a3e8/jekyll-theme-console
|
38
|
+
```
|
29
39
|
|
30
|
-
|
40
|
+
### Gem-based method
|
31
41
|
|
32
|
-
|
42
|
+
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.
|
33
43
|
|
34
|
-
|
44
|
+
This allows for easier installation and updating as you don't have to manage any of the theme files. To install:
|
45
|
+
|
46
|
+
1. Add this line to your Jekyll site's `Gemfile`:
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
gem "jekyll-theme-console"
|
50
|
+
```
|
51
|
+
|
52
|
+
2. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command:
|
53
|
+
|
54
|
+
```bash
|
55
|
+
bundle
|
56
|
+
```
|
57
|
+
|
58
|
+
3. Set `theme` in your project's Jekyll `_config.yml` file:
|
59
|
+
|
60
|
+
```yaml
|
61
|
+
theme: jekyll-theme-console
|
62
|
+
```
|
63
|
+
|
64
|
+
To update the theme run `bundle update`.
|
35
65
|
|
36
66
|
## Usage
|
37
67
|
|
68
|
+
### _config.yaml
|
69
|
+
|
38
70
|
In addition to jekyll's default configuration options, you can provide:
|
39
71
|
- `header_pages` to specify which pages should be displayed in navbar
|
40
72
|
- `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
|
73
|
+
- `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)
|
74
|
+
- `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)
|
75
|
+
- `style` to specify which predefined style (colors) should be used
|
43
76
|
|
44
77
|
```yaml
|
45
78
|
header_pages:
|
46
79
|
- index.md
|
47
80
|
- about.md
|
48
81
|
|
49
|
-
style: dark # dark (default) or
|
50
|
-
listen_for_clients_preferred_style: true #
|
82
|
+
style: dark # dark (default), light or hacker
|
83
|
+
listen_for_clients_preferred_style: true # false (default) or true
|
51
84
|
|
52
85
|
footer: 'follow us on <a href="https://twitter.com/xxx">twitter</a>'
|
53
86
|
|
54
87
|
google_analytics: UA-NNNNNNNN-N
|
55
88
|
```
|
56
89
|
|
90
|
+
### front matter variables
|
91
|
+
|
92
|
+
Besides the predefined [front matter](https://jekyllrb.com/docs/front-matter/) variables from jekyll this theme also supports following variables:
|
93
|
+
- `title` to set a title for the page
|
94
|
+
- `lang` to specify the language, defaults to 'en'
|
95
|
+
- `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
|
96
|
+
|
57
97
|
## Customization
|
58
98
|
|
59
99
|
If you want to customize this theme, follow this steps:
|
data/_includes/head.html
CHANGED
@@ -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
|
-
|
13
|
-
|
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 -%}
|
data/_sass/_dark.scss
CHANGED
data/_sass/_hacker.scss
ADDED
@@ -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
|
+
}
|
data/_sass/_light.scss
CHANGED
data/_sass/base.scss
CHANGED
@@ -19,20 +19,13 @@ 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
|
-
/*h1:before { content: "#"; margin-right: 9px; }
|
25
|
-
h2:before { content: "##"; margin-right: 9px; }
|
26
|
-
h3:before { content: "###"; margin-right: 9px; }
|
27
|
-
h4:before { content: "####"; margin-right: 9px; }
|
28
|
-
h5:before { content: "#####"; margin-right: 9px; }
|
29
|
-
h6:before { content: "######"; margin-right: 9px; }*/
|
30
23
|
|
31
24
|
/**
|
32
25
|
* Layout
|
33
26
|
*/
|
34
27
|
.container { width: $container-width; max-width: $container-max-width; margin-right: auto; margin-left: auto; }
|
35
|
-
p { word-wrap: break-word; word-break: break-word; white-space: pre-wrap; }
|
28
|
+
p { word-wrap: break-word; word-break: break-word; white-space: pre-wrap; margin-bottom: 15px; }
|
36
29
|
footer { color: var(--text-color); border-top: var(--border); margin: 20px auto 15px; padding-top: 10px; text-align: right; }
|
37
30
|
header { margin-top: 25px; margin-bottom: 10px; }
|
38
31
|
header p { text-align: left; margin: 0; }
|
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.
|
4
|
+
version: 0.3.12
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- b2a3e8
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2020-11-18 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
|