jekyll-dash 2.1.0 → 2.3.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +45 -14
- data/_includes/author.html +7 -17
- data/_includes/avatar.html +16 -0
- data/_layouts/default.html +1 -1
- data/_layouts/home.html +1 -1
- data/_layouts/post.html +1 -1
- data/_layouts/tag_page.html +1 -1
- data/_sass/dash/_layout.scss +63 -5
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d4b0d408e8c2385413ac3386e6fefd4767b80c6fa023b129d702448e54abf605
|
4
|
+
data.tar.gz: 96d8601fdb46b995a4419f10ea207ce51461460fe6a08715e1e53ec3ff90dca5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 272d5349e5e05e5d86fb983f0972b7439195ec5a3f51fe44b1dfb43a109d82cf0925bb7d23be8639cecb48662d527573cea28d44d81d44967a91e16299d4d93b
|
7
|
+
data.tar.gz: 835f090778f1f5bd9ce2d82666f11284121fefd0494a40330e4897ebc04e6d63183d39cbb5e02402c10c9597634f3d3dd0241b204d4ea603f7b499c69d6b985b
|
data/README.md
CHANGED
@@ -3,29 +3,39 @@
|
|
3
3
|
|
4
4
|
A dark and light theme for Jekyll, inspired by Dash UI for Atom. 🌒☀
|
5
5
|
|
6
|
-
|
6
|
+
![Build Tag](https://github.com/bitbrain/jekyll-dash/actions/workflows/build-tag.yml/badge.svg)
|
7
7
|
[![license](https://img.shields.io/github/license/bitbrain/jekyll-dash.svg?style=flat-square)](LICENSE.MD)
|
8
|
-
[![Gem](https://
|
8
|
+
[![Gem](https://badgen.net/rubygems/v/jekyll-dash)](https://badgen.net/rubygems/v/jekyll-dash "View this project in Rubygems")
|
9
9
|
[![Downloads](https://ruby-gem-downloads-badge.herokuapp.com/jekyll-dash)](https://rubygems.org/gems/jekyll-dash "Number of Gem downloads")
|
10
10
|
---
|
11
11
|
This theme for [Jekyll](https://jekyllrb.com/) has been inspired by [dash-ui](https://atom.io/themes/dash-ui), a dark theme for [Atom](https://atom.io).
|
12
12
|
|
13
13
|
[![design](theme.gif)](http://bitbrain.github.io)
|
14
14
|
|
15
|
+
## Features
|
16
|
+
|
17
|
+
#### :first_quarter_moon: Dark/Light Mode
|
18
|
+
#### :arrow_left: Right-to-Left (RTL) Support
|
19
|
+
#### :bookmark: Tags
|
20
|
+
#### :orange_book: Pagination
|
21
|
+
#### :computer: Syntax Highlighting
|
22
|
+
#### :wave: Customisable Avatar Box
|
23
|
+
#### :two_hearts: Social Links
|
24
|
+
|
15
25
|
## Installation
|
16
26
|
|
17
27
|
Add this line to your Jekyll site's `Gemfile`:
|
18
28
|
|
19
29
|
For **Jekyll 3**:
|
20
30
|
```ruby
|
21
|
-
gem 'jekyll-dash', '~> 1
|
31
|
+
gem 'jekyll-dash', '~> 1'
|
22
32
|
```
|
23
33
|
|
24
34
|
> Keep in mind: Github pages generation only supports Jekyll 3.8 right now.
|
25
35
|
|
26
36
|
For **Jekyll 4**:
|
27
37
|
```ruby
|
28
|
-
gem 'jekyll-dash', '~> 2
|
38
|
+
gem 'jekyll-dash', '~> 2'
|
29
39
|
```
|
30
40
|
|
31
41
|
And add this line to your Jekyll site's `_config.yml`:
|
@@ -60,10 +70,24 @@ tag_page_layout: tag_page
|
|
60
70
|
tag_page_dir: tag
|
61
71
|
|
62
72
|
dash:
|
73
|
+
# the way how dates should be displayed
|
63
74
|
date_format: "%b %-d, %Y"
|
64
75
|
|
76
|
+
# (optional) discqus comment configuration
|
65
77
|
disqus:
|
66
|
-
shortname: <your-disqus-shortname>
|
78
|
+
shortname: <your-disqus-shortname>
|
79
|
+
|
80
|
+
# the animation speed of the post scroll-in effect
|
81
|
+
animation_speed: 50
|
82
|
+
|
83
|
+
# wether to enable Right-to-Left support or not
|
84
|
+
rtl: false
|
85
|
+
|
86
|
+
# Replaces the default avatar provider (gravatar)
|
87
|
+
#avatar_source: github
|
88
|
+
#github_username: bitbrain
|
89
|
+
#avatar_source: local
|
90
|
+
#avatar_path: /assets/avatar.png
|
67
91
|
|
68
92
|
# generate social links in footer
|
69
93
|
# supported colors: green, red, orange, blue, cyan, pink, teal, yellow, indigo, purple
|
@@ -77,21 +101,17 @@ dash:
|
|
77
101
|
- url: https://github.com/bitbrain
|
78
102
|
icon: github-square
|
79
103
|
color: purple
|
80
|
-
|
104
|
+
|
105
|
+
# wether the author box should be displayed or not
|
81
106
|
show_author: true
|
82
|
-
|
83
|
-
# Replaces the default avatar provider (gravatar)
|
84
|
-
#avatar_source: github
|
85
|
-
#github_username: bitbrain
|
86
107
|
```
|
87
108
|
## Using this theme directly on Github Pages
|
88
109
|
|
89
|
-
Please keep in mind that Github Pages does only support [a limited list of Jekyll plugins](https://pages.github.com/versions/). You will be able to use this theme on Github Pages but some functionality might not be available, for example displaying tags. In order to use this theme to a full extend, you have to generate the `_site`
|
110
|
+
Please keep in mind that Github Pages does only support [a limited list of Jekyll plugins](https://pages.github.com/versions/). You will be able to use this theme on Github Pages but some functionality might not be available, for example displaying tags. In order to use this theme to a full extend, you have to generate the `_site` [separately via Github Actions](https://jekyllrb.com/docs/continuous-integration/github-actions/).
|
90
111
|
|
91
|
-
|
112
|
+
* `<username>.github.io` - contains main source branch and orphan gh-pages branch ([see example](https://github.com/bitbrain/bitbrain.github.io))
|
92
113
|
|
93
|
-
|
94
|
-
* `<username>.github.io` - contains generated webpage, pushed automatically via TravisCI ([see example](https://github.com/bitbrain/bitbrain.github.io))
|
114
|
+
I have created [a guide on how to set this up here](https://bitbra.in/2021/10/03/host-your-own-blog-for-free-with-custom-domain.html).
|
95
115
|
|
96
116
|
You are not required to do this, but keep in mind that some functionality might not be available when using the Jekyll generator on Github directly!
|
97
117
|
|
@@ -129,6 +149,15 @@ gem "liquid-md5"
|
|
129
149
|
|
130
150
|
Make sure you are using a version of this theme that is compatible with Jekyll. Version 1.x is only compatible with Jekyll 3.x while Version 2.x is only compatible with Jekyll 4.x.
|
131
151
|
|
152
|
+
> I am getting an error 'cannot load such file --webrick' when trying to run `bundle exec jekyll serve`
|
153
|
+
|
154
|
+
**Solution**
|
155
|
+
|
156
|
+
As [explained here](https://github.com/jekyll/jekyll/issues/8523#issuecomment-751409319) this seems to be a bug with some recent Jekyll 4 version. To solve this simply run:
|
157
|
+
```bash
|
158
|
+
bundle add webrick
|
159
|
+
```
|
160
|
+
|
132
161
|
## Contributing
|
133
162
|
|
134
163
|
Bug reports and pull requests are welcome on GitHub at https://github.com/bitbrain/jekyll-dash. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
@@ -142,6 +171,8 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun
|
|
142
171
|
When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
|
143
172
|
To add a custom directory to your theme-gem, please edit the regexp in `jekyll-dash.gemspec` accordingly.
|
144
173
|
|
174
|
+
> If you want to learn how Jekyll Dash gets deployed via Github Actions, feel free [to read this article](https://bitbra.in/2021/10/05/workflow-of-releasing-gem-based-jekyll-theme.html) written by me.
|
175
|
+
|
145
176
|
## License
|
146
177
|
|
147
178
|
The theme is available as open source under the terms of the [Apache License 2.0](https://opensource.org/licenses/Apache-2.0).
|
data/_includes/author.html
CHANGED
@@ -1,19 +1,9 @@
|
|
1
1
|
<div class="author-box">
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
{% endcapture %}
|
10
|
-
{% elsif site.plugins contains "liquid-md5" %}
|
11
|
-
{% capture avatar_image %}
|
12
|
-
https://gravatar.com/avatar/{{ site.email | downcase | md5 }}?s=256
|
13
|
-
{% endcapture %}
|
14
|
-
{% endif %}
|
15
|
-
{% if avatar_image %}
|
16
|
-
<img src="{{ avatar_image }}" class="author-avatar" alt="Avatar" />
|
17
|
-
{% endif %}
|
18
|
-
{{ site.description }}
|
2
|
+
{% if site.dash.rtl %}
|
3
|
+
<div class="description">{{ site.description }}</div>
|
4
|
+
{%- include avatar.html -%}
|
5
|
+
{% else %}
|
6
|
+
{%- include avatar.html -%}
|
7
|
+
<div class="description">{{ site.description }}</div>
|
8
|
+
{% endif %}
|
19
9
|
</div>
|
@@ -0,0 +1,16 @@
|
|
1
|
+
{% if site.dash.avatar_source == "github" and site.dash.github_username %}
|
2
|
+
{% capture avatar_image %}
|
3
|
+
https://github.com/{{ site.dash.github_username }}.png
|
4
|
+
{% endcapture %}
|
5
|
+
{% elsif site.dash.avatar_source == "local" and site.dash.avatar_path %}
|
6
|
+
{% capture avatar_image %}
|
7
|
+
{{site.dash.avatar_path}}
|
8
|
+
{% endcapture %}
|
9
|
+
{% elsif site.plugins contains "liquid-md5" %}
|
10
|
+
{% capture avatar_image %}
|
11
|
+
https://gravatar.com/avatar/{{ site.email | downcase | md5 }}?s=256
|
12
|
+
{% endcapture %}
|
13
|
+
{% endif %}
|
14
|
+
{% if avatar_image %}
|
15
|
+
<img src="{{ avatar_image }}" class="author-avatar" alt="Avatar" />
|
16
|
+
{% endif %}
|
data/_layouts/default.html
CHANGED
data/_layouts/home.html
CHANGED
@@ -17,7 +17,7 @@ layout: default
|
|
17
17
|
{% if site.plugins contains "jekyll/tagging" %}
|
18
18
|
<div class="post-tags">
|
19
19
|
{% for tag in post.tags %}
|
20
|
-
<a class="tag" href="
|
20
|
+
<a class="tag" href="{{ tag | tag_url }}">{{ tag }}</a>
|
21
21
|
{% endfor %}
|
22
22
|
</div>
|
23
23
|
{% endif %}
|
data/_layouts/post.html
CHANGED
@@ -9,7 +9,7 @@ layout: default
|
|
9
9
|
{% if site.plugins contains "jekyll/tagging" %}
|
10
10
|
<div class="post-tags">
|
11
11
|
{% for tag in page.tags %}
|
12
|
-
<a class="tag" href="
|
12
|
+
<a class="tag" href="{{ tag | tag_url }}">{{ tag }}</a>
|
13
13
|
{% endfor %}
|
14
14
|
</div>
|
15
15
|
{% endif %}
|
data/_layouts/tag_page.html
CHANGED
data/_sass/dash/_layout.scss
CHANGED
@@ -52,21 +52,75 @@
|
|
52
52
|
}
|
53
53
|
|
54
54
|
/**
|
55
|
-
*
|
55
|
+
* Right-to-Left support
|
56
56
|
*/
|
57
57
|
|
58
|
+
html.direction--rtl {
|
59
|
+
.author-box {
|
60
|
+
text-align: right;
|
61
|
+
& > .description {
|
62
|
+
direction: rtl;
|
63
|
+
}
|
64
|
+
& > img {
|
65
|
+
margin-right: 0em;
|
66
|
+
margin-left: 1em;
|
67
|
+
}
|
68
|
+
}
|
69
|
+
ol > li, ul > li {
|
70
|
+
text-align: right;
|
71
|
+
direction: rtl;
|
72
|
+
&::before {
|
73
|
+
float: right;
|
74
|
+
margin-left: 0.5em;
|
75
|
+
}
|
76
|
+
}
|
77
|
+
h1, h2, h3, h4, h5, h6 {
|
78
|
+
direction: rtl;
|
79
|
+
text-align: right;
|
80
|
+
}
|
81
|
+
.post-link-wrapper {
|
82
|
+
direction: rtl;
|
83
|
+
}
|
84
|
+
.post {
|
85
|
+
direction: rtl;
|
86
|
+
}
|
87
|
+
.pagination {
|
88
|
+
text-align: right;
|
89
|
+
}
|
90
|
+
.tag-cloud {
|
91
|
+
direction: rtl;
|
92
|
+
text-align: right;
|
93
|
+
}
|
94
|
+
.related-posts {
|
95
|
+
direction: rtl;
|
96
|
+
text-align: right;
|
97
|
+
|
98
|
+
& > li::before {
|
99
|
+
margin-right: 0;
|
100
|
+
margin-left: 0.5em;
|
101
|
+
}
|
102
|
+
}
|
103
|
+
pre {
|
104
|
+
direction: ltr;
|
105
|
+
text-align: left;
|
106
|
+
}
|
107
|
+
}
|
108
|
+
|
58
109
|
.author-box {
|
59
110
|
margin-bottom: 1em;
|
60
111
|
text-align: left;
|
61
112
|
min-height: 72px;
|
62
113
|
font-style: italic;
|
114
|
+
display: inline-flex;
|
115
|
+
& > .description {
|
116
|
+
flex:8;
|
117
|
+
}
|
63
118
|
& > .author-avatar {
|
64
|
-
float: left;
|
65
|
-
white-space: pre-line;
|
66
119
|
margin-right: 1em;
|
67
120
|
width: 72px;
|
68
|
-
height:
|
121
|
+
height: 100%;
|
69
122
|
border-radius: 0.3em;
|
123
|
+
flex: 1;
|
70
124
|
}
|
71
125
|
}
|
72
126
|
|
@@ -169,7 +223,7 @@
|
|
169
223
|
}
|
170
224
|
|
171
225
|
& > p {
|
172
|
-
display: block;
|
226
|
+
display: inline-block;
|
173
227
|
padding-left: 3em;
|
174
228
|
}
|
175
229
|
|
@@ -182,6 +236,10 @@
|
|
182
236
|
font-size: 2em;
|
183
237
|
}
|
184
238
|
|
239
|
+
& > ul {
|
240
|
+
margin-left: 3em;
|
241
|
+
}
|
242
|
+
|
185
243
|
li {
|
186
244
|
@include themed() {
|
187
245
|
color: t('quote-secondary');
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: jekyll-dash
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.
|
4
|
+
version: 2.3.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Miguel Gonzalez Sanchez
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-12-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: jekyll
|
@@ -104,6 +104,7 @@ files:
|
|
104
104
|
- LICENSE
|
105
105
|
- README.md
|
106
106
|
- _includes/author.html
|
107
|
+
- _includes/avatar.html
|
107
108
|
- _includes/disqus.html
|
108
109
|
- _includes/footer.html
|
109
110
|
- _includes/head.html
|