doccoli-jekyll 1.1.2 → 1.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 4688d32b0bcaa82e78857a36374688c81c8cb835
4
- data.tar.gz: a5177d7230e076bf3adb442926d8bb17f2387bcb
3
+ metadata.gz: 404c28527334403054de5fecb5ee38df9297c217
4
+ data.tar.gz: dadb8e0b2184e859811c1dcd683cbdfa091b27b3
5
5
  SHA512:
6
- metadata.gz: efc3b22a48b6783b70ec115208e50b5861b04b74786404b67c9e9c4d641080910c1f1aa1ec314b0c94f8746fe366c3b6809a41babbf44895549419781727bbf5
7
- data.tar.gz: 6279d9928b0a0b783c67372c6067f2f66205f0e7c9869ed8fa7e0675625ffdcbdb483b2e59991aaa9d646fe9b2a3b641489f41805398e0621d00bac5369acf0b
6
+ metadata.gz: 7a5dc04c10309e557ab805ea4f883e1a75e6a778fee649d8bfffe5a7643a9dab632e6bb5708cd15c10be59d5c839f7e5e84543485db883b6b7ec26539ee5cb1c
7
+ data.tar.gz: ac51c7a78dc28d438cc48184e23c6491ecf171e8c9112948a17796d5e4deac79446ab172c76bd4c3b48fa4c222dccaedd894e4301659c570a729691a48d58f94
data/README.md CHANGED
@@ -1,8 +1,10 @@
1
1
  # doccoli-jekyll
2
2
 
3
- The `doccoli-jekyll` is the Jekyll theme in use at [The Bubblin Blog](https://bubblin.io/blog/). It is a particularly useful theme for situations where you want to add a blog to your site, say on the side of your rails app (website) or over a url like this:
3
+ The `doccoli-jekyll` is the Jekyll theme in use for documentation at [Bubblin Superbooks](https://bubblin.io/docs/). It is a particularly useful theme for products made by solo founders (developers) or a bootstrapped team with very limited resources.
4
4
 
5
- > https://example.com/blog/
5
+ Easily add a responsive "blog-like" implementation for product documentation on your website; something like say on the side of your rails app over a url like this:
6
+
7
+ > https://example.com/docs/
6
8
 
7
9
 
8
10
  `doccoli-jekyll` was originally a fork off of [Minima](https://github.com/jekyll/minima)—the default gem-theme of Jekyll-but it has been rewritten completely using the [Toucaan CSS](https://github.com/marvindanig/toucaan) fundamentals for its themed layout.
@@ -21,10 +23,12 @@ Add this line to your Jekyll site's Gemfile:
21
23
  gem "doccoli-jekyll"
22
24
  ```
23
25
 
24
- And add this line to your Jekyll site:
26
+ And add this line to your Jekyll site (_config.yml) and set `search: true`:
25
27
 
26
28
  ```yaml
27
29
  theme: doccoli-jekyll
30
+
31
+ search: true
28
32
  ```
29
33
 
30
34
  And then execute:
@@ -1,4 +1,4 @@
1
- <aside class="sidebar left top fixed">
1
+ <aside class="sidebar left top fixed hide-on-mobiles">
2
2
 
3
3
  <ul class="toc">
4
4
  {% for post in site.posts %}
@@ -1,4 +1,3 @@
1
- @import "scss/content";
2
1
  @import "scss/footer";
3
2
  @import "scss/header";
4
3
  @import "scss/sidebar";
@@ -239,9 +239,11 @@ th {
239
239
 
240
240
  .container {
241
241
  margin: 44px 0 0 0;
242
- width: calc(100vw - 208px);
243
242
  background: white;
244
- margin-left: 208px;
243
+ }
244
+
245
+ .wrapper {
246
+ margin: 0 auto;
245
247
  }
246
248
 
247
249
  .left {
@@ -491,6 +493,10 @@ ul.horizontal-list li {
491
493
  .align {
492
494
  margin: 0 0;
493
495
  }
496
+ .container {
497
+ width: calc(100vw - 208px);
498
+ margin-left: 208px;
499
+ }
494
500
  }
495
501
  }
496
502
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: doccoli-jekyll
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.2
4
+ version: 1.1.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Marvin Danig
@@ -94,10 +94,8 @@ files:
94
94
  - _layouts/post.html
95
95
  - _sass/doccoli-jekyll.scss
96
96
  - _sass/scss/_base.scss
97
- - _sass/scss/_content.scss
98
97
  - _sass/scss/_footer.scss
99
98
  - _sass/scss/_header.scss
100
- - _sass/scss/_layout.scss
101
99
  - _sass/scss/_reusable.scss
102
100
  - _sass/scss/_sidebar.scss
103
101
  - _sass/scss/_syntax-highlighting.scss
@@ -1,3 +0,0 @@
1
- .wrapper {
2
- margin: 0 auto;
3
- }
@@ -1,250 +0,0 @@
1
- /**
2
- * Site header
3
- */
4
- .site-header {
5
- border-top: 5px solid $grey-color-dark;
6
- border-bottom: 1px solid $grey-color-light;
7
- min-height: $spacing-unit * 1.865;
8
-
9
- // Positioning context for the mobile navigation icon
10
- position: relative;
11
- }
12
-
13
- .site-title {
14
- @include relative-font-size(1.625);
15
- font-weight: 300;
16
- line-height: $base-line-height * $base-font-size * 2.25;
17
- letter-spacing: -1px;
18
- margin-bottom: 0;
19
- float: left;
20
-
21
- &,
22
- &:visited {
23
- color: $grey-color-dark;
24
- }
25
- }
26
-
27
- .site-nav {
28
- float: right;
29
- line-height: $base-line-height * $base-font-size * 2.25;
30
-
31
- .nav-trigger {
32
- display: none;
33
- }
34
-
35
- .menu-icon {
36
- display: none;
37
- }
38
-
39
- .page-link {
40
- color: $text-color;
41
- line-height: $base-line-height;
42
-
43
- // Gaps between nav items, but not on the last one
44
- &:not(:last-child) {
45
- margin-right: 20px;
46
- }
47
- }
48
-
49
- @include media-query($on-palm) {
50
- position: absolute;
51
- top: 9px;
52
- right: $spacing-unit / 2;
53
- background-color: $background-color;
54
- border: 1px solid $grey-color-light;
55
- border-radius: 5px;
56
- text-align: right;
57
-
58
- label[for="nav-trigger"] {
59
- display: block;
60
- float: right;
61
- width: 36px;
62
- height: 36px;
63
- z-index: 2;
64
- cursor: pointer;
65
- }
66
-
67
- .menu-icon {
68
- display: block;
69
- float: right;
70
- width: 36px;
71
- height: 26px;
72
- line-height: 0;
73
- padding-top: 10px;
74
- text-align: center;
75
-
76
- > svg path {
77
- fill: $grey-color-dark;
78
- }
79
- }
80
-
81
- input ~ .trigger {
82
- clear: both;
83
- display: none;
84
- }
85
-
86
- input:checked ~ .trigger {
87
- display: block;
88
- padding-bottom: 5px;
89
- }
90
-
91
- .page-link {
92
- display: block;
93
- padding: 5px 10px;
94
-
95
- &:not(:last-child) {
96
- margin-right: 0;
97
- }
98
- margin-left: 20px;
99
- }
100
- }
101
- }
102
-
103
-
104
-
105
- /**
106
- * Site footer
107
- */
108
- .site-footer {
109
- border-top: 1px solid $grey-color-light;
110
- padding: $spacing-unit 0;
111
- }
112
-
113
- .footer-heading {
114
- @include relative-font-size(1.125);
115
- margin-bottom: $spacing-unit / 2;
116
- }
117
-
118
- .contact-list,
119
- .social-media-list {
120
- list-style: none;
121
- margin-left: 0;
122
- }
123
-
124
- .footer-col-wrapper {
125
- @include relative-font-size(0.9375);
126
- color: $grey-color;
127
- margin-left: -$spacing-unit / 2;
128
- @extend %clearfix;
129
- }
130
-
131
- .footer-col {
132
- float: left;
133
- margin-bottom: $spacing-unit / 2;
134
- padding-left: $spacing-unit / 2;
135
- }
136
-
137
- .footer-col-1 {
138
- width: -webkit-calc(35% - (#{$spacing-unit} / 2));
139
- width: calc(35% - (#{$spacing-unit} / 2));
140
- }
141
-
142
- .footer-col-2 {
143
- width: -webkit-calc(20% - (#{$spacing-unit} / 2));
144
- width: calc(20% - (#{$spacing-unit} / 2));
145
- }
146
-
147
- .footer-col-3 {
148
- width: -webkit-calc(45% - (#{$spacing-unit} / 2));
149
- width: calc(45% - (#{$spacing-unit} / 2));
150
- }
151
-
152
- @include media-query($on-laptop) {
153
- .footer-col-1,
154
- .footer-col-2 {
155
- width: -webkit-calc(50% - (#{$spacing-unit} / 2));
156
- width: calc(50% - (#{$spacing-unit} / 2));
157
- }
158
-
159
- .footer-col-3 {
160
- width: -webkit-calc(100% - (#{$spacing-unit} / 2));
161
- width: calc(100% - (#{$spacing-unit} / 2));
162
- }
163
- }
164
-
165
- @include media-query($on-palm) {
166
- .footer-col {
167
- float: none;
168
- width: -webkit-calc(100% - (#{$spacing-unit} / 2));
169
- width: calc(100% - (#{$spacing-unit} / 2));
170
- }
171
- }
172
-
173
-
174
-
175
- /**
176
- * Page content
177
- */
178
- .page-content {
179
- padding: $spacing-unit 0;
180
- }
181
-
182
- .page-heading {
183
- @include relative-font-size(1.25);
184
- }
185
-
186
- .post-list {
187
- margin-left: 0;
188
- list-style: none;
189
-
190
- > li {
191
- margin-bottom: $spacing-unit;
192
- }
193
- }
194
-
195
- .post-meta {
196
- font-size: $small-font-size;
197
- color: $grey-color;
198
- }
199
-
200
- .post-link {
201
- display: block;
202
- @include relative-font-size(1.5);
203
- }
204
-
205
-
206
-
207
- /**
208
- * Posts
209
- */
210
- .post-header {
211
- margin-bottom: $spacing-unit;
212
- }
213
-
214
- .post-title {
215
- @include relative-font-size(2.625);
216
- letter-spacing: -1px;
217
- line-height: 1;
218
-
219
- @include media-query($on-laptop) {
220
- @include relative-font-size(2.25);
221
- }
222
- }
223
-
224
- .post-content {
225
- margin-bottom: $spacing-unit;
226
-
227
- h2 {
228
- @include relative-font-size(2);
229
-
230
- @include media-query($on-laptop) {
231
- @include relative-font-size(1.75);
232
- }
233
- }
234
-
235
- h3 {
236
- @include relative-font-size(1.625);
237
-
238
- @include media-query($on-laptop) {
239
- @include relative-font-size(1.375);
240
- }
241
- }
242
-
243
- h4 {
244
- @include relative-font-size(1.25);
245
-
246
- @include media-query($on-laptop) {
247
- @include relative-font-size(1.125);
248
- }
249
- }
250
- }