jekyll-theme-miniplex 0.10.0 → 0.11.0

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: c45ca6694d6c5bf57671b8deb295eba737cd51086a97c36da45ed1696f69db3b
4
- data.tar.gz: 39442e86cf8f846eb8a5e9525dde40e25367aad79f4fc4186c6b211cade9b455
3
+ metadata.gz: 1f9a4eb82bd23673683f3c3081242818cfbba646ab65928acc19921ca74c218e
4
+ data.tar.gz: 6e1a0882e28b4bdc100e1614dc720eda582e0dcab3ae640eacf95605be5990bd
5
5
  SHA512:
6
- metadata.gz: d52cc355fcc661118970171b8c8b46dfe7b623c5e43bc3ab7b3ea1248f9fba99af71d7208ffcad7ccd368878f1093041eaaa0378ec52c0c754127117fa2a871c
7
- data.tar.gz: 37fd7dc6de44f0ff8e82af53e4bbafb4984ed3c7d734a5479e50daac547b863312bef5a1cbe2ec691abd023054ddf9abd28dda71bf87adb11126d243ef94d0c3
6
+ metadata.gz: b13916d83cb7d3444f4e17b199e0d3628c70b44e013279b459a3e984ba9458f1e85f124b6daa000f65e1fbd66f67fa56709987cd9f36b68a18d36eb91d560d34
7
+ data.tar.gz: 914deaf93d0958c19187eaf56010966f58b3222c146cda319efa717fcfd70cd775b8dd5fb0936e464d0e50bdeb20280d4c5a2ed3258b22df394e3ac0ef7826da
data/README.md CHANGED
@@ -1,20 +1,29 @@
1
1
  # jekyll-theme-miniplex
2
2
 
3
- A theme for [Jekyll](https://jekyllrb.com/). Features and characteristics:
3
+ A theme for [Jekyll](https://jekyllrb.com/). Features:
4
4
 
5
+ - Light & dark modes.
6
+ - Table reformatting on mobile and for very small screens.
7
+ - Styles for printing.
8
+ - At least some basic accessibility.
5
9
  - Responsive.
6
- - Table reformatting for very small screens.
7
10
  - Hamburger menu at the bottom right, easy to reach.
8
11
  - Uses the [IBM Plex](https://www.ibm.com/plex/) typeface, hence the name.
9
12
 
10
- I'm using this for my personal web site, so don't expect this to fit your needs.
13
+ I'm using this for [my personal web site](https://timowuersch.com/), so don't expect this to fit your needs.
11
14
 
12
15
  ## What it looks like
13
16
 
17
+ ### On desktop
18
+
14
19
  ![](screenshot.png)
15
20
 
16
21
 
17
22
 
23
+ ### On mobile
24
+
25
+ ![](screenshot-mobile.png)
26
+
18
27
  ## Installation
19
28
 
20
29
  Add the following to your Jekyll site's `Gemfile`:
@@ -22,19 +31,27 @@ Add the following to your Jekyll site's `Gemfile`:
22
31
  ```ruby
23
32
  gem "jekyll-theme-miniplex"
24
33
 
25
- # jekyll-theme-miniplex depends on this.
34
+ # jekyll-theme-miniplex depends on these.
26
35
  gem "jekyll-titles-from-headings", "~> 0.5.3"
36
+ gem "jekyll-seo-tag"
27
37
 
28
38
  # Use the most recent version of jekyll-sass-converter, to force Dart Sass
29
39
  gem "sass-embedded"
30
40
  gem "jekyll-sass-converter", github: "jekyll/jekyll-sass-converter"
31
41
  ```
32
42
 
43
+ (Note that this will also install [jekyll-titles-from-headings](https://github.com/benbalter/jekyll-titles-from-headings) and [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag/), which this theme depends on.)
44
+
33
45
  Add the following to your Jekyll site's `_config.yml`:
34
46
 
35
47
  ```yaml
36
48
  theme: jekyll-theme-miniplex
37
49
 
50
+ plugins:
51
+ - jekyll-coffeescript
52
+ - jekyll-titles-from-headings
53
+ - jekyll-seo-tag
54
+
38
55
  titles_from_headings:
39
56
  enabled: true
40
57
  strip_title: true
@@ -63,9 +80,16 @@ miniplex:
63
80
  mobile_nav_menu_title: "Menü"
64
81
  ```
65
82
 
83
+ ### Navigation & footer content, and additional HEAD content
84
+
85
+ Optionally, put any of the following files into the `_includes` folder to override or extend the defaults:
86
+
87
+ - `footer.html` contains the footer content
88
+ - `additional_head_tags.html` will be included at the end of the HEAD block, before BODY starts
89
+ - `navigation_desktop.html` and `navigation_mobile.html` contain the contents of the desktop and mobile navigation, respectively.
90
+
66
91
  ## ToDos & Missing Features
67
92
 
68
- - [ ] Footer
69
93
  - [ ] In-page navigation
70
94
  - [ ] Maximizable tables
71
95
  - [ ] Breadcrumbs, if possible
@@ -76,6 +100,7 @@ miniplex:
76
100
 
77
101
  Most recent at the top.
78
102
 
103
+ - [X] Footer
79
104
  - [X] Dark mode
80
105
  - [X] Print CSS
81
106
  - [X] Mobile nav bugfixing
data/_config.yml CHANGED
@@ -7,6 +7,7 @@ title: Miniplex Theme for Jekyll
7
7
  plugins:
8
8
  - jekyll-coffeescript
9
9
  - jekyll-titles-from-headings
10
+ - jekyll-seo-tag
10
11
 
11
12
  exclude:
12
13
  - .sass-cache/
@@ -1,9 +1,6 @@
1
1
  <!doctype html>
2
2
  <html lang="en">
3
3
  <head>
4
-
5
- <title>{{ page.title }} - {{ site.title }}</title>
6
-
7
4
  <meta charset="utf-8">
8
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
9
6
  <meta name="theme-color" content="#ffffff">
@@ -13,6 +10,7 @@
13
10
 
14
11
  {% include additional_head_tags.html %}
15
12
 
13
+ {% seo %}
16
14
  </head>
17
15
 
18
16
  <body>
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-miniplex
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.0
4
+ version: 0.11.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Timo Würsch