jekyll-theme-basically-basic 1.0.1 → 1.1.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
  SHA1:
3
- metadata.gz: 8c5b0fb77ba201d31e0fa3d2a564179032c9b619
4
- data.tar.gz: 1ef5d067aeb68ea4e6937f6ab6b6e4fc60f9c811
3
+ metadata.gz: f2e0ab57f483f56071db22e3e78effbd02cd3995
4
+ data.tar.gz: b664f1ffb586edaf91b519aa576d462ce1a8a399
5
5
  SHA512:
6
- metadata.gz: 5e5ec8132130fe21f317d293e66920f4a480bceae0fedec5e60f20bb0427ea25d7a5d452bb955e208c527f867ff6d6ae5af28c5cf3827b313ae9738b4b5a4612
7
- data.tar.gz: fa96e40f23e536a607e880e5c7707b805e4171c240f6655abdf3e17c1331bb40a0652b2e0d5bfeb914bcbef02ecd43eb7d8bf97c0e6bdc8dfe14d1d6ef783565
6
+ metadata.gz: c37d965922b6c8ba8f035b524f0d7fe9768f0f0a6ae98e2696bc758bae9cdd353e649e5260f3451d6e049297318875c6abbeb6a43a2426c3649c9932d92dc4f9
7
+ data.tar.gz: c9b2989456d7cc6fcb07b9c2efd97a43decd6057f8a9f37a37dd582d645269a96826242d777080ac0d9bf2b5b6b7cb31613b6478ba721e6204794ff6b75326c4
@@ -1,14 +1,31 @@
1
- # Change Log
2
-
3
- All notable changes to this project will be documented in this file.
4
-
5
- The format is based on [Keep a Changelog](http://keepachangelog.com/)
6
- and this project adheres to [Semantic Versioning](http://semver.org/).
7
-
8
- ## [1.0.1] - 2017-03-23
9
- ### Added
10
- - Responsive embed helper classes for videos. [#2](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/2)
11
- - Print styles for improved readability of printed pages. [#4](https://github.com/mmistakes/jekyll-theme-basically-basic/pull/4)
12
- - Icon list to README.
13
-
14
- ## [1.0.0] - 2017-03-20
1
+ # Change Log
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](http://keepachangelog.com/)
6
+ and this project adheres to [Semantic Versioning](http://semver.org/).
7
+
8
+ ## [Unreleased]
9
+
10
+ ## [1.1.0] - 2017-03-30
11
+ ### Added
12
+ - Improved installation documentation. [#8](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/8)
13
+ - Google Analytics tracking ID, Disqus comments, to `/docs` demo site.
14
+
15
+ ### Changed
16
+ - Change source order of `.sidebar` and `.canvas` so menu items can easily be "tabbed" to. [#10](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/10)
17
+ - Refactor sidebar off-canvas menu and improve animation. [#9](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/9) [#15](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/15)
18
+ - Removed tinted background from `<th>` elements.
19
+ - Permalink structure of `/docs` demo site.
20
+
21
+ ### Fixed
22
+ - `body` height and `.wrapper` box shadow. [#13](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/13)
23
+ - Unclickable main content links in Internet Explorer 10. [#9](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/9)
24
+
25
+ ## [1.0.1] - 2017-03-23
26
+ ### Added
27
+ - Responsive embed helper classes for videos. [#2](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/2)
28
+ - Print styles for improved readability of printed pages. [#4](https://github.com/mmistakes/jekyll-theme-basically-basic/pull/4)
29
+ - Icon list to README.
30
+
31
+ ## [1.0.0] - 2017-03-20
data/README.md CHANGED
@@ -23,7 +23,13 @@ with a few enhancements thrown in for good measure:
23
23
  ## Table of Contents
24
24
 
25
25
  1. [Installation](#installation)
26
- 2. [Configuration](#configuration)
26
+ 1. [Ruby Gem Method](#ruby-gem-method)
27
+ 2. [GitHub Pages Compatible Method](#github-pages-compatible-method)
28
+ 1. [Remove the Unnecessary](#remove-the-unnecessary)
29
+ 2. [Structure](#structure)
30
+ 1. [Starting Fresh](#starting-fresh)
31
+ 2. [Starting from jekyll new](#starting-from-jekyll-new)
32
+ 3. [Configuration](#configuration)
27
33
  1. [Skin](#skin)
28
34
  2. [Google Fonts](#google-fonts)
29
35
  3. [Text](#text)
@@ -33,26 +39,33 @@ with a few enhancements thrown in for good measure:
33
39
  7. [Reading Time](#reading-time)
34
40
  8. [Comments (via Disqus)](#comments-via-disqus)
35
41
  9. [Google Analytics](#google-analytics)
36
- 3. [Layouts](#layouts)
42
+ 4. [Layouts](#layouts)
37
43
  1. [Default](#layout-default)
38
44
  2. [Post](#layout-post)
39
45
  3. [Page](#layout-page)
40
46
  4. [Home](#layout-home)
41
47
  5. [About](#layout-about)
42
48
  6. [Curriculum Vitæ/Resume](#layout-cv)
43
- 4. [Customization](#customization)
49
+ 5. [Customization](#customization)
44
50
  1. [Overriding Includes and Layouts](#overriding-includes-and-layouts)
45
51
  2. [Customizing Sass (SCSS)](#customizing-sass-scss)
46
52
  3. [Customizing JavaScript](#customizing-javascript)
47
53
  4. [SVG Icons](#svg-icons)
48
54
  5. [Customizing Sidebar Content](#customizing-sidebar-content)
49
- 5. [Development](#development)
50
- 6. [Contributing](#contributing)
55
+ 6. [Development](#development)
56
+ 7. [Contributing](#contributing)
51
57
  1. [Pull Requests](#pull-requests)
52
- 7. [Credits](#credits)
58
+ 8. [Credits](#credits)
53
59
 
54
60
  ## Installation
55
61
 
62
+ If you're running Jekyll v3.3+ and self-hosting you can quickly install the
63
+ theme as Ruby gem. If you're hosting with GitHub Pages you'll have to use the
64
+ "repo fork" method or directly copy all of the theme files (see
65
+ [structure](#structure) below) into your project.
66
+
67
+ ### Ruby Gem Method
68
+
56
69
  1. Install the theme as a Ruby Gem by adding it to your `Gemfile` like so:
57
70
 
58
71
  ```ruby
@@ -72,9 +85,91 @@ with a few enhancements thrown in for good measure:
72
85
  theme: jekyll-theme-basically-basic
73
86
  ```
74
87
 
75
- **Note:** 3rd-party Ruby gem themes aren't currently supported on sites hosted
76
- with [GitHub Pages](https://pages.github.com/). Basically Basic can still be
77
- used on GH Pages, but you will need to fork the theme instead.
88
+ ### GitHub Pages Compatible Method
89
+
90
+ Fork the [Basically Basic repo](https://github.com/mmistakes/jekyll-theme-basically-basic/fork),
91
+ then rename it to **USERNAME.github.io** --- replacing **USERNAME** with your
92
+ GitHub username.
93
+
94
+ **Note:** Your Jekyll site should be viewable immediately at
95
+ <http://USERNAME.github.io>. If it's not, you can force a rebuild by
96
+ **configuring your site** (see below for more details).
97
+
98
+ Replace the contents of `Gemfile` found in the root of your Jekyll site with
99
+ the following:
100
+
101
+ ```ruby
102
+ source "https://rubygems.org"
103
+
104
+ gem "github-pages", group: :jekyll_plugins
105
+ ```
106
+
107
+ Then run `bundle update` and verify that the [GitHub Pages gem](https://github.com/github/pages-gem)
108
+ and its dependencies install properly.
109
+
110
+ #### Remove the Unnecessary
111
+
112
+ If you forked or downloaded the `jekyll-theme-basically-basic` repo you can
113
+ safely remove the following files and folders:
114
+
115
+ - `.codeclimate.yml`
116
+ - `.editorconfig`
117
+ - `.gitattributes`
118
+ - `.github`
119
+ - `.scss-lint.yml`
120
+ - `CHANGELOG.md`
121
+ - `jekyll-theme-basically-basic.gemspec`
122
+ - `LICENSE.md`
123
+ - `Rakefile`
124
+ - `README.md`
125
+ - `screenshot.png`
126
+ - `/docs`
127
+ - `/example`
128
+
129
+ ## Structure
130
+
131
+ Layouts, includes, Sass partials, and data files are all placed in their default
132
+ locations. Stylesheets and scripts in `assets`, and a few development related
133
+ files in the project's root directory.
134
+
135
+ **Please note:** If you installed Basically Basic via the Ruby Gem method, theme
136
+ files found in `/_layouts`, `/_includes`, `/_sass`, and `/assets` will be
137
+ missing. This is normal as they are bundled with the [`jekyll-theme-basically-basic`](https://rubygems.org/gems/jekyll-theme-basically-basic) gem.
138
+
139
+ ```bash
140
+ jekyll-theme-basically-basic
141
+ ├── _data # data files
142
+ | └── theme.yml # theme settings and custom text
143
+ ├── _includes # theme includes and SVG icons
144
+ ├── _layouts # theme layouts (see below for details)
145
+ ├── _sass # Sass partials
146
+ ├── assets
147
+ | ├── javascripts
148
+ | | └── main.js
149
+ | └── stylesheets
150
+ | └── main.scss
151
+ ├── _config.yml # sample configuration
152
+ └── index.md # sample home page (all posts/not paginated)
153
+ ```
154
+
155
+ ### Starting Fresh
156
+
157
+ After creating a `Gemfile` and installing the theme you'll need to add and edit
158
+ the following files:
159
+
160
+ - [`_config.yml`](_config.yml)
161
+ - [`/_data/theme.yml`](_data/theme.yml)
162
+ - [`index.md`](index.md)
163
+
164
+ **Note:** Consult the [**pagination**](#pagination) documentation below for
165
+ instructions on how to enable it for the home page.
166
+
167
+ ### Starting from `jekyll new`
168
+
169
+ Using the `jekyll new` command will get you up and running the quickest.
170
+
171
+ Edit `_config.yml` and create `_data/theme.yml` as instructed above and you're
172
+ good to go.
78
173
 
79
174
  ## Configuration
80
175
 
@@ -196,13 +291,18 @@ following pagination settings:
196
291
  ```
197
292
 
198
293
  3. Create `index.html` (or rename `index.md`) in the root of your project and
199
- add `layout: home` `paginate: true` to its YAML Front Matter.
294
+ add the following front matter:
295
+
296
+ ```yaml
297
+ layout: home
298
+ paginate: true
299
+ ```
200
300
 
201
301
  ### Author
202
302
 
203
303
  Author information is used as meta data for post "by lines" and propagates the
204
- `creator` field of Twitter summary cards with the following YAML Front Matter
205
- in `_config.yml`:
304
+ `creator` field of Twitter summary cards with the following front matter in
305
+ `_config.yml`:
206
306
 
207
307
  ```yaml
208
308
  author:
@@ -211,8 +311,8 @@ author:
211
311
  picture: /assets/images/johndoe.png
212
312
  ```
213
313
 
214
- Site-wide author information can be overridden in a document's YAML Front Matter
215
- in the same way:
314
+ Site-wide author information can be overridden in a document's front matter in
315
+ the same way:
216
316
 
217
317
  ```yaml
218
318
  author:
@@ -221,9 +321,9 @@ author:
221
321
  picture: /assets/images/janedoe.png
222
322
  ```
223
323
 
224
- Or by specifying a corresponding key in the document's YAML Front Matter, that
324
+ Or by specifying a corresponding key in the document's front matter, that
225
325
  exists in `site.data.authors`. E.g., you have the following in the document's
226
- YAML Front Matter:
326
+ front matter:
227
327
 
228
328
  ```yaml
229
329
  author: megaman
@@ -268,7 +368,7 @@ with the following [environment value](http://jekyllrb.com/docs/configuration/#s
268
368
  `JEKYLL_ENV=production`
269
369
 
270
370
  If you don't want to display comments for a particular post you can disable
271
- them by adding `comments: false` to that post's YAML Front Matter.
371
+ them by adding `comments: false` to that post's front matter.
272
372
 
273
373
  ### Google Analytics
274
374
 
@@ -302,7 +402,7 @@ and provide additional styling and features inside of the `{{ content }}` block.
302
402
 
303
403
  ### `layout: post`
304
404
 
305
- This layout accommodates the following YAML Front Matter:
405
+ This layout accommodates the following front matter:
306
406
 
307
407
  ```yaml
308
408
  # optional alternate title to replace page.title at the top of the page
@@ -344,7 +444,7 @@ differences.
344
444
 
345
445
  ### `layout: home`
346
446
 
347
- This layout accommodates the same YAML Front Matter as `layout: page`, with the
447
+ This layout accommodates the same front matter as `layout: page`, with the
348
448
  addition of the following:
349
449
 
350
450
  ```yaml
@@ -353,7 +453,7 @@ paginate: true # enables pagination loop, see section above for additional setu
353
453
 
354
454
  ### `layout: about`
355
455
 
356
- This layout accommodates the same YAML Front Matter as `layout: page`, with the
456
+ This layout accommodates the same front matter as `layout: page`, with the
357
457
  addition of the following to display an author picture:
358
458
 
359
459
  ```yaml
@@ -363,14 +463,14 @@ author:
363
463
  ```
364
464
 
365
465
  Recommended `picture` size is approximately `300 x 300` pixels. If `author`
366
- object is not explicitly set in the about page's YAML Front Matter the theme
466
+ object is not explicitly set in the about page's front matter the theme
367
467
  will default to the value set in `_config.yml`.
368
468
 
369
469
  If blank there no image will appear.
370
470
 
371
471
  ### `layout: cv`
372
472
 
373
- This layout accommodates the same YAML Front Matter as `layout: page`. It
473
+ This layout accommodates the same front matter as `layout: page`. It
374
474
  leverages a [JSON-based file standard](https://jsonresume.org/schema/) for
375
475
  resume data to conveniently render a curriculum vitæ or resume painlessly.
376
476
 
@@ -558,8 +658,9 @@ When submitting a pull request:
558
658
  `my-awesome-new-feature`) and describe the feature or fix.
559
659
  3. Open a pull request on GitHub.
560
660
 
561
- Sample pages can be found in the [`/docs`](docs) folder if you'd like to tackle
562
- any "low-hanging fruit" like fixing typos, bad grammar, etc.
661
+ Sample pages can be found in the [`/docs`](docs) and [`/example`](/example)
662
+ folders if you'd like to tackle any "low-hanging fruit" like fixing typos, bad
663
+ grammar, etc.
563
664
 
564
665
  ---
565
666
 
@@ -1,8 +1,8 @@
1
- <section>
1
+ <nav class="skip-links">
2
2
  <h2 class="screen-reader-text">{{ site.data.theme.t.skip_links | default: 'Skip links' }}</h2>
3
- <ul class="skip-links">
3
+ <ul>
4
4
  <li><a href="#primary-nav" class="screen-reader-shortcut">{{ site.data.theme.t.skip_primary_nav | default: 'Skip to primary navigation' }}</a></li>
5
5
  <li><a href="#main" class="screen-reader-shortcut">{{ site.data.theme.t.skip_content | default: 'Skip to content' }}</a></li>
6
6
  <li><a href="#footer" class="screen-reader-shortcut">{{ site.data.theme.t.skip_footer | default: 'Skip to footer' }}</a></li>
7
7
  </ul>
8
- </section>
8
+ </nav>
@@ -1,38 +1,42 @@
1
- <!DOCTYPE html>
2
- <!--
3
- Basically Basic Jekyll Theme 1.0.1
4
- Copyright 2017 Michael Rose - mademistakes.com | @mmistakes
5
- Free for personal and commercial use under the MIT license
6
- https://github.com/mmistakes/jekyll-basically-theme/blob/master/LICENSE.md
7
- -->
8
- <html lang="{{ page.lang | default: site.lang | default: 'en-US' }}" class="no-js">
9
- {% include head.html %}
10
-
11
- <body class="layout--{{ page.layout | default: layout.layout }}{% if page.classes or layout.classes %}{{ page.classes | default: layout.classes | join: ' ' | prepend: ' ' }}{% endif %} {{ page.title | slugify }}">
12
-
13
- {% include skip-links.html %}
14
-
15
- <div class="sidebar-toggle-wrapper">
16
- <a class="toggle navicon-button larr" href="#sidebar">
17
- <span class="sidebar-toggle-label">{{ site.data.theme.t.menu | default: 'Menu' }}</span>
18
- <div class="navicon"></div>
19
- </a>
20
- </div>
21
-
22
- <div class="wrapper">
23
- {% include masthead.html %}
24
- {{ content }}
25
- </div>
26
-
27
- <div id="sidebar" class="sidebar">
28
- <div class="inner">
29
- {% include navigation.html %}
30
- {% include contact-list.html %}
31
- </div>
32
- </div>
33
-
34
- {% include scripts.html %}
35
-
36
- </body>
37
-
38
- </html>
1
+ <!DOCTYPE html>
2
+ <!--
3
+ Basically Basic Jekyll Theme 1.1.0
4
+ Copyright 2017 Michael Rose - mademistakes.com | @mmistakes
5
+ Free for personal and commercial use under the MIT license
6
+ https://github.com/mmistakes/jekyll-basically-theme/blob/master/LICENSE.md
7
+ -->
8
+ <html lang="{{ page.lang | default: site.lang | default: 'en-US' }}" class="no-js">
9
+ {% include head.html %}
10
+
11
+ <body class="layout--{{ page.layout | default: layout.layout }}{% if page.classes or layout.classes %}{{ page.classes | default: layout.classes | join: ' ' | prepend: ' ' }}{% endif %} {{ page.title | slugify }}">
12
+
13
+ {% include skip-links.html %}
14
+
15
+ <div class="sidebar-toggle-wrapper">
16
+ <button class="toggle navicon-button larr" type="button">
17
+ <span class="toggle-inner">
18
+ <span class="sidebar-toggle-label">{{ site.data.theme.t.menu | default: 'Menu' }}</span>
19
+ <span class="navicon"></span>
20
+ </span>
21
+ </button>
22
+ </div>
23
+
24
+ <div id="sidebar" class="sidebar">
25
+ <div class="inner">
26
+ {% include navigation.html %}
27
+ {% include contact-list.html %}
28
+ </div>
29
+ </div>
30
+
31
+ <div class="canvas">
32
+ <div class="wrapper">
33
+ {% include masthead.html %}
34
+ {{ content }}
35
+ </div>
36
+ </div>
37
+
38
+ {% include scripts.html %}
39
+
40
+ </body>
41
+
42
+ </html>
@@ -1,41 +1,41 @@
1
- /*!
2
- * Basically Basic Jekyll Theme 1.0.1
3
- * Copyright 2017 Michael Rose - mademistakes | @mmistakes
4
- * Free for personal and commercial use under the MIT license
5
- * https://github.com/mmistakes/jekyll-theme-basically-basic/blob/master/LICENSE.md
6
- */
7
-
8
- /* Mixins and functions */
9
- @import 'basically-basic/vendor/susy';
10
- @import 'basically-basic/vendor/breakpoint';
11
- @include breakpoint-set('to ems', true);
12
- @import 'basically-basic/mixins';
13
-
14
- /* Variables */
15
- @import 'basically-basic/variables';
16
-
17
- /* Core CSS */
18
- @import 'basically-basic/reset';
19
- @import 'basically-basic/base';
20
- @import 'basically-basic/layout';
21
- @import 'basically-basic/tables';
22
-
23
- /* Components */
24
- @import 'basically-basic/global';
25
- @import 'basically-basic/sidebar';
26
- @import 'basically-basic/navigation';
27
- @import 'basically-basic/footer';
28
- @import 'basically-basic/entries';
29
- @import 'basically-basic/buttons';
30
- @import 'basically-basic/icons';
31
- @import 'basically-basic/intro';
32
- @import 'basically-basic/navicons';
33
- @import 'basically-basic/contact-lists';
34
- @import 'basically-basic/syntax-highlighting';
35
- @import 'basically-basic/responsive-embed';
36
-
37
- /* Utility classes */
38
- @import 'basically-basic/utilities';
39
-
40
- /* Print */
41
- @import 'basically-basic/print';
1
+ /*!
2
+ * Basically Basic Jekyll Theme 1.1.0
3
+ * Copyright 2017 Michael Rose - mademistakes | @mmistakes
4
+ * Free for personal and commercial use under the MIT license
5
+ * https://github.com/mmistakes/jekyll-theme-basically-basic/blob/master/LICENSE.md
6
+ */
7
+
8
+ /* Mixins and functions */
9
+ @import 'basically-basic/vendor/susy';
10
+ @import 'basically-basic/vendor/breakpoint';
11
+ @include breakpoint-set('to ems', true);
12
+ @import 'basically-basic/mixins';
13
+
14
+ /* Variables */
15
+ @import 'basically-basic/variables';
16
+
17
+ /* Core CSS */
18
+ @import 'basically-basic/reset';
19
+ @import 'basically-basic/base';
20
+ @import 'basically-basic/layout';
21
+ @import 'basically-basic/tables';
22
+
23
+ /* Components */
24
+ @import 'basically-basic/global';
25
+ @import 'basically-basic/sidebar';
26
+ @import 'basically-basic/navigation';
27
+ @import 'basically-basic/footer';
28
+ @import 'basically-basic/entries';
29
+ @import 'basically-basic/buttons';
30
+ @import 'basically-basic/icons';
31
+ @import 'basically-basic/intro';
32
+ @import 'basically-basic/navicons';
33
+ @import 'basically-basic/contact-lists';
34
+ @import 'basically-basic/syntax-highlighting';
35
+ @import 'basically-basic/responsive-embed';
36
+
37
+ /* Utility classes */
38
+ @import 'basically-basic/utilities';
39
+
40
+ /* Print */
41
+ @import 'basically-basic/print';