jekyll-theme-basically-basic 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (195) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +19 -0
  3. data/LICENSE.md +21 -0
  4. data/README.md +582 -0
  5. data/_includes/author +31 -0
  6. data/_includes/contact-list.html +27 -0
  7. data/_includes/cv/awards.html +24 -0
  8. data/_includes/cv/basics.html +69 -0
  9. data/_includes/cv/education.html +36 -0
  10. data/_includes/cv/interests.html +20 -0
  11. data/_includes/cv/intro.html +18 -0
  12. data/_includes/cv/languages.html +20 -0
  13. data/_includes/cv/publications.html +30 -0
  14. data/_includes/cv/references.html +24 -0
  15. data/_includes/cv/skills.html +20 -0
  16. data/_includes/cv/volunteer.html +46 -0
  17. data/_includes/cv/work.html +46 -0
  18. data/_includes/disqus_comments.html +17 -0
  19. data/_includes/entry.html +29 -0
  20. data/_includes/footer.html +9 -0
  21. data/_includes/google-analytics.html +9 -0
  22. data/_includes/head-feed.html +1 -0
  23. data/_includes/head-seo.html +1 -0
  24. data/_includes/head.html +35 -0
  25. data/_includes/icon-arrow-left.svg +1 -0
  26. data/_includes/icon-arrow-right.svg +1 -0
  27. data/_includes/icon-bitbucket.html +4 -0
  28. data/_includes/icon-bitbucket.svg +1 -0
  29. data/_includes/icon-calendar.svg +1 -0
  30. data/_includes/icon-codepen.html +4 -0
  31. data/_includes/icon-codepen.svg +1 -0
  32. data/_includes/icon-download.svg +1 -0
  33. data/_includes/icon-dribbble.html +4 -0
  34. data/_includes/icon-dribbble.svg +1 -0
  35. data/_includes/icon-email.svg +1 -0
  36. data/_includes/icon-facebook.html +4 -0
  37. data/_includes/icon-facebook.svg +1 -0
  38. data/_includes/icon-flickr.html +4 -0
  39. data/_includes/icon-flickr.svg +1 -0
  40. data/_includes/icon-github.html +4 -0
  41. data/_includes/icon-github.svg +1 -0
  42. data/_includes/icon-gitlab.html +4 -0
  43. data/_includes/icon-gitlab.svg +1 -0
  44. data/_includes/icon-googleplus.html +4 -0
  45. data/_includes/icon-googleplus.svg +1 -0
  46. data/_includes/icon-instagram.html +4 -0
  47. data/_includes/icon-instagram.svg +1 -0
  48. data/_includes/icon-lastfm.html +4 -0
  49. data/_includes/icon-lastfm.svg +1 -0
  50. data/_includes/icon-linkedin.html +4 -0
  51. data/_includes/icon-linkedin.svg +1 -0
  52. data/_includes/icon-pdf.svg +1 -0
  53. data/_includes/icon-pinterest.html +4 -0
  54. data/_includes/icon-pinterest.svg +1 -0
  55. data/_includes/icon-rss.svg +1 -0
  56. data/_includes/icon-soundcloud.html +4 -0
  57. data/_includes/icon-soundcloud.svg +1 -0
  58. data/_includes/icon-stackoverflow.html +4 -0
  59. data/_includes/icon-stackoverflow.svg +1 -0
  60. data/_includes/icon-stopwatch.svg +1 -0
  61. data/_includes/icon-tumblr.html +4 -0
  62. data/_includes/icon-tumblr.svg +1 -0
  63. data/_includes/icon-twitter.html +4 -0
  64. data/_includes/icon-twitter.svg +1 -0
  65. data/_includes/icon-xing.html +4 -0
  66. data/_includes/icon-xing.svg +1 -0
  67. data/_includes/icon-youtube.html +4 -0
  68. data/_includes/icon-youtube.svg +1 -0
  69. data/_includes/masthead.html +27 -0
  70. data/_includes/navigation.html +25 -0
  71. data/_includes/page-intro.html +42 -0
  72. data/_includes/posts-all.html +3 -0
  73. data/_includes/posts-paginated.html +16 -0
  74. data/_includes/read-time.html +13 -0
  75. data/_includes/scripts.html +5 -0
  76. data/_includes/skip-links.html +8 -0
  77. data/_layouts/about.html +21 -0
  78. data/_layouts/cv.html +28 -0
  79. data/_layouts/default.html +38 -0
  80. data/_layouts/home.html +30 -0
  81. data/_layouts/page.html +17 -0
  82. data/_layouts/post.html +20 -0
  83. data/_sass/basically-basic.scss +37 -0
  84. data/_sass/basically-basic/_base.scss +110 -0
  85. data/_sass/basically-basic/_buttons.scss +39 -0
  86. data/_sass/basically-basic/_contact-lists.scss +11 -0
  87. data/_sass/basically-basic/_entries.scss +155 -0
  88. data/_sass/basically-basic/_footer.scss +13 -0
  89. data/_sass/basically-basic/_global.scss +36 -0
  90. data/_sass/basically-basic/_icons.scss +43 -0
  91. data/_sass/basically-basic/_intro.scss +65 -0
  92. data/_sass/basically-basic/_layout.scss +178 -0
  93. data/_sass/basically-basic/_mixins.scss +7 -0
  94. data/_sass/basically-basic/_navicons.scss +144 -0
  95. data/_sass/basically-basic/_navigation.scss +51 -0
  96. data/_sass/basically-basic/_reset.scss +522 -0
  97. data/_sass/basically-basic/_sidebar.scss +177 -0
  98. data/_sass/basically-basic/_syntax-highlighting.scss +127 -0
  99. data/_sass/basically-basic/_tables.scss +42 -0
  100. data/_sass/basically-basic/_utilities.scss +5 -0
  101. data/_sass/basically-basic/_variables.scss +84 -0
  102. data/_sass/basically-basic/mixins/_clearfix.scss +11 -0
  103. data/_sass/basically-basic/mixins/_color.scss +21 -0
  104. data/_sass/basically-basic/mixins/_float.scss +15 -0
  105. data/_sass/basically-basic/mixins/_fluid-type.scss +33 -0
  106. data/_sass/basically-basic/mixins/_image.scss +38 -0
  107. data/_sass/basically-basic/mixins/_lists.scss +9 -0
  108. data/_sass/basically-basic/mixins/_text-truncate.scss +10 -0
  109. data/_sass/basically-basic/themes/_default.scss +5 -0
  110. data/_sass/basically-basic/themes/_night.scss +12 -0
  111. data/_sass/basically-basic/themes/_plum.scss +12 -0
  112. data/_sass/basically-basic/themes/_sea.scss +12 -0
  113. data/_sass/basically-basic/themes/_soft.scss +12 -0
  114. data/_sass/basically-basic/themes/_steel.scss +12 -0
  115. data/_sass/basically-basic/utilities/_accessibility.scss +54 -0
  116. data/_sass/basically-basic/utilities/_align.scss +64 -0
  117. data/_sass/basically-basic/utilities/_clearfix.scss +7 -0
  118. data/_sass/basically-basic/utilities/_float.scss +7 -0
  119. data/_sass/basically-basic/utilities/_text.scss +28 -0
  120. data/_sass/basically-basic/vendor/_breakpoint.scss +114 -0
  121. data/_sass/basically-basic/vendor/_su.scss +4 -0
  122. data/_sass/basically-basic/vendor/_susy.scss +4 -0
  123. data/_sass/basically-basic/vendor/_susyone.scss +4 -0
  124. data/_sass/basically-basic/vendor/breakpoint/_context.scss +95 -0
  125. data/_sass/basically-basic/vendor/breakpoint/_helpers.scss +151 -0
  126. data/_sass/basically-basic/vendor/breakpoint/_legacy-settings.scss +50 -0
  127. data/_sass/basically-basic/vendor/breakpoint/_no-query.scss +15 -0
  128. data/_sass/basically-basic/vendor/breakpoint/_parsers.scss +215 -0
  129. data/_sass/basically-basic/vendor/breakpoint/_respond-to.scss +82 -0
  130. data/_sass/basically-basic/vendor/breakpoint/_settings.scss +71 -0
  131. data/_sass/basically-basic/vendor/breakpoint/parsers/_double.scss +33 -0
  132. data/_sass/basically-basic/vendor/breakpoint/parsers/_query.scss +82 -0
  133. data/_sass/basically-basic/vendor/breakpoint/parsers/_resolution.scss +31 -0
  134. data/_sass/basically-basic/vendor/breakpoint/parsers/_single.scss +26 -0
  135. data/_sass/basically-basic/vendor/breakpoint/parsers/_triple.scss +36 -0
  136. data/_sass/basically-basic/vendor/breakpoint/parsers/double/_default-pair.scss +21 -0
  137. data/_sass/basically-basic/vendor/breakpoint/parsers/double/_default.scss +22 -0
  138. data/_sass/basically-basic/vendor/breakpoint/parsers/double/_double-string.scss +22 -0
  139. data/_sass/basically-basic/vendor/breakpoint/parsers/resolution/_resolution.scss +60 -0
  140. data/_sass/basically-basic/vendor/breakpoint/parsers/single/_default.scss +13 -0
  141. data/_sass/basically-basic/vendor/breakpoint/parsers/triple/_default.scss +18 -0
  142. data/_sass/basically-basic/vendor/susy/_su.scss +7 -0
  143. data/_sass/basically-basic/vendor/susy/language/_susy.scss +24 -0
  144. data/_sass/basically-basic/vendor/susy/language/_susyone.scss +13 -0
  145. data/_sass/basically-basic/vendor/susy/language/susy/_background.scss +385 -0
  146. data/_sass/basically-basic/vendor/susy/language/susy/_bleed.scss +200 -0
  147. data/_sass/basically-basic/vendor/susy/language/susy/_box-sizing.scss +47 -0
  148. data/_sass/basically-basic/vendor/susy/language/susy/_breakpoint-plugin.scss +185 -0
  149. data/_sass/basically-basic/vendor/susy/language/susy/_container.scss +81 -0
  150. data/_sass/basically-basic/vendor/susy/language/susy/_context.scss +36 -0
  151. data/_sass/basically-basic/vendor/susy/language/susy/_gallery.scss +94 -0
  152. data/_sass/basically-basic/vendor/susy/language/susy/_grids.scss +64 -0
  153. data/_sass/basically-basic/vendor/susy/language/susy/_gutters.scss +154 -0
  154. data/_sass/basically-basic/vendor/susy/language/susy/_isolate.scss +77 -0
  155. data/_sass/basically-basic/vendor/susy/language/susy/_margins.scss +94 -0
  156. data/_sass/basically-basic/vendor/susy/language/susy/_padding.scss +74 -0
  157. data/_sass/basically-basic/vendor/susy/language/susy/_rows.scss +138 -0
  158. data/_sass/basically-basic/vendor/susy/language/susy/_settings.scss +216 -0
  159. data/_sass/basically-basic/vendor/susy/language/susy/_span.scss +163 -0
  160. data/_sass/basically-basic/vendor/susy/language/susy/_validation.scss +16 -0
  161. data/_sass/basically-basic/vendor/susy/language/susyone/_background.scss +18 -0
  162. data/_sass/basically-basic/vendor/susy/language/susyone/_functions.scss +377 -0
  163. data/_sass/basically-basic/vendor/susy/language/susyone/_grid.scss +312 -0
  164. data/_sass/basically-basic/vendor/susy/language/susyone/_isolation.scss +51 -0
  165. data/_sass/basically-basic/vendor/susy/language/susyone/_margin.scss +93 -0
  166. data/_sass/basically-basic/vendor/susy/language/susyone/_media.scss +105 -0
  167. data/_sass/basically-basic/vendor/susy/language/susyone/_padding.scss +92 -0
  168. data/_sass/basically-basic/vendor/susy/language/susyone/_settings.scss +60 -0
  169. data/_sass/basically-basic/vendor/susy/output/_float.scss +9 -0
  170. data/_sass/basically-basic/vendor/susy/output/_shared.scss +15 -0
  171. data/_sass/basically-basic/vendor/susy/output/_support.scss +9 -0
  172. data/_sass/basically-basic/vendor/susy/output/float/_container.scss +16 -0
  173. data/_sass/basically-basic/vendor/susy/output/float/_end.scss +40 -0
  174. data/_sass/basically-basic/vendor/susy/output/float/_isolate.scss +22 -0
  175. data/_sass/basically-basic/vendor/susy/output/float/_span.scss +35 -0
  176. data/_sass/basically-basic/vendor/susy/output/shared/_background.scss +26 -0
  177. data/_sass/basically-basic/vendor/susy/output/shared/_container.scss +21 -0
  178. data/_sass/basically-basic/vendor/susy/output/shared/_direction.scss +42 -0
  179. data/_sass/basically-basic/vendor/susy/output/shared/_inspect.scss +25 -0
  180. data/_sass/basically-basic/vendor/susy/output/shared/_margins.scss +23 -0
  181. data/_sass/basically-basic/vendor/susy/output/shared/_output.scss +14 -0
  182. data/_sass/basically-basic/vendor/susy/output/shared/_padding.scss +23 -0
  183. data/_sass/basically-basic/vendor/susy/output/support/_background.scss +58 -0
  184. data/_sass/basically-basic/vendor/susy/output/support/_box-sizing.scss +19 -0
  185. data/_sass/basically-basic/vendor/susy/output/support/_clearfix.scss +18 -0
  186. data/_sass/basically-basic/vendor/susy/output/support/_prefix.scss +19 -0
  187. data/_sass/basically-basic/vendor/susy/output/support/_rem.scss +22 -0
  188. data/_sass/basically-basic/vendor/susy/output/support/_support.scss +85 -0
  189. data/_sass/basically-basic/vendor/susy/su/_grid.scss +103 -0
  190. data/_sass/basically-basic/vendor/susy/su/_settings.scss +73 -0
  191. data/_sass/basically-basic/vendor/susy/su/_utilities.scss +111 -0
  192. data/_sass/basically-basic/vendor/susy/su/_validation.scss +57 -0
  193. data/assets/javascripts/main.js +57 -0
  194. data/assets/stylesheets/main.scss +10 -0
  195. metadata +335 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 14662b9a358b2eb887af8fc1623c0cb6de784f27
4
+ data.tar.gz: 71e9c94fc12a4d5208b4e79b1af41ffc4d116563
5
+ SHA512:
6
+ metadata.gz: a50425e711f8d12aca56c23f2e1446ed113204ef51351251ec25b594a5d29d3da055b4fda4eef12376122ac6552d8367e3cbd64349e4a89f0374cf1cc2b3e56c
7
+ data.tar.gz: 52bdb8d3ba5d38d41d8d152f4e0515ec9308c403b26069799350d17c812d8eb895b28a2d795f7a2b2c224b681e6c28820b94c24767a14a3602a5caa4cc3bea1d
data/CHANGELOG.md ADDED
@@ -0,0 +1,19 @@
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] - YYYY-MM-DD
9
+ ### Added
10
+ - for new features
11
+
12
+ ### Changed
13
+ - for changes in existing functionality
14
+
15
+ ### Deprecated
16
+ - for once-stable features removed in upcoming releases
17
+
18
+ ### Fixed
19
+ - for any bug fixes
data/LICENSE.md ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Michael Rose
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,582 @@
1
+ # [Basically Basic Jekyll Theme][1]
2
+
3
+ [![license](https://img.shields.io/github/license/mmistakes/jekyll-theme-basically-basic.svg?style=flat-square)](LICENSE.md)
4
+ [![Code Climate](https://img.shields.io/codeclimate/github/mmistakes/jekyll-theme-basically-basic.svg?style=flat-square)](https://codeclimate.com/github/mmistakes/jekyll-theme-basically-basic)
5
+
6
+ Basically Basic is a [Jekyll theme](https://jekyllrb.com/docs/themes/) meant as
7
+ a substitute for the default --- [Minima](https://github.com/jekyll/minima).
8
+ Conventions and features found there are fully supported by **Basically Basic**,
9
+ with a few enhancements thrown in for good measure:
10
+
11
+ - Clean responsive design with [six customizable skins](#skin)
12
+ - Curriculum Vitæ/Resume layout powered by [JSON data](http://registry.jsonresume.org/)
13
+ - About page layout
14
+ - Disqus Comments and Google Analytics support
15
+ - SEO best practices via [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag/)
16
+
17
+ [![Basically Basic live preview][2]][1]
18
+
19
+ [1]: https://mmistakes.github.io/jekyll-theme-basically-basic/
20
+ [2]: https://cloud.githubusercontent.com/assets/1376749/24117647/6dede894-0d81-11e7-9c2c-f19bea45e219.jpg (live preview)
21
+
22
+ ## Table of Contents
23
+
24
+ 1. [Installation](#installation)
25
+ 2. [Configuration](#configuration)
26
+ 1. [Skin](#skin)
27
+ 2. [Google Fonts](#google-fonts)
28
+ 3. [Text](#text)
29
+ 4. [Navigation](#navigation)
30
+ 5. [Pagination](#pagination)
31
+ 6. [Author](#author)
32
+ 7. [Reading Time](#reading-time)
33
+ 8. [Comments (via Disqus)](#comments-via-disqus)
34
+ 9. [Google Analytics](#google-analytics)
35
+ 3. [Layouts](#layouts)
36
+ 1. [Default](#layout-default)
37
+ 2. [Post](#layout-post)
38
+ 3. [Page](#layout-page)
39
+ 4. [Home](#layout-home)
40
+ 5. [About](#layout-about)
41
+ 6. [Curriculum Vitæ/Resume](#layout-cv)
42
+ 4. [Customization](#customization)
43
+ 1. [Overriding Includes and Layouts](#overriding-includes-and-layouts)
44
+ 2. [Customizing Sass (SCSS)](#customizing-sass-scss)
45
+ 3. [Customizing JavaScript](#customizing-javascript)
46
+ 4. [SVG Icons](#svg-icons)
47
+ 5. [Customizing Sidebar Content](#customizing-sidebar-content)
48
+ 5. [Development](#development)
49
+ 6. [Contributing](#contributing)
50
+ 1. [Pull Requests](#pull-requests)
51
+ 7. [Credits](#credits)
52
+
53
+ ## Installation
54
+
55
+ 1. Install the theme as a Ruby Gem by adding it to your `Gemfile` like so:
56
+
57
+ ```ruby
58
+ gem "jekyll-theme-basically-basic", :git => "https://github.com/mmistakes/jekyll-theme-basically-basic.git"
59
+ ```
60
+
61
+ 2. Fetch and update your bundled gems by running the following
62
+ [Bundler](http://bundler.io/) command:
63
+
64
+ ```bash
65
+ bundle
66
+ ```
67
+
68
+ 3. Set the `theme` in your project's Jekyll configuration, `_config.yml`:
69
+
70
+ ```yaml
71
+ theme: jekyll-theme-basically-basic
72
+ ```
73
+
74
+ **Note:** 3rd-party Ruby gem themes aren't currently supported on sites hosted
75
+ with [GitHub Pages](https://pages.github.com/). Basically Basic can still be
76
+ used on GH Pages, but you will need to fork the theme instead.
77
+
78
+ ## Configuration
79
+
80
+ Configuration of site-wide elements (`lang`, `title`, `description`, `logo`,
81
+ `author`, etc.) happens in your project's `_config.yml`. See the
82
+ [example configuration](example/_config.yml) in this repo for additional
83
+ reference.
84
+
85
+ | | Description |
86
+ | ------------------ | ------------------------------------------------------------------------- |
87
+ | `lang` | Used to indicate the language of text (e.g., en-US, en-GB, fr) |
88
+ | `title` | Your site's title (e.g., Dungan's Awesome Site) |
89
+ | `description` | Short site description (e.g., A blog about grasshopper mash) |
90
+ | `url` | The full URL to your site (e.g., https://groverloaf.org) |
91
+ | `author` | Global author information (see below) |
92
+ | `logo` | Path to a site-wide logo ~100x100px (e.g., /assets/your-company-logo.png) |
93
+ | `twitter_username` | Site-wide Twitter username, used as a link in sidebar |
94
+ | `github_username` | Site-wide GitHub username, used as a link in sidebar |
95
+
96
+ For more configuration options be sure to consult the documentation for:
97
+ [**jekyll-seo-tag**][jekyll-seo-tag], [**jekyll-feed**][jekyll-feed],
98
+ [**jekyll-paginate**][jekyll-paginate], and [**jekyll-sitemap**][jekyll-sitemap].
99
+
100
+ [jekyll-seo-tag]: https://github.com/jekyll/jekyll-seo-tag
101
+ [jekyll-feed]: https://github.com/jekyll/jekyll-feed
102
+ [jekyll-paginate]: https://github.com/jekyll/jekyll-paginate
103
+ [jekyll-sitemap]: https://github.com/jekyll/jekyll-sitemap
104
+
105
+ ### Skin
106
+
107
+ This theme comes in six different skins (color variations). To change skins add
108
+ one of the following to your [`/_data/theme.yml`](_data/theme.yml) file:
109
+
110
+ | `skin: default` | `skin: night` | `skin: plum` |
111
+ | --- | --- | --- |
112
+ | ![default-skin](https://cloud.githubusercontent.com/assets/1376749/24115744/c0618c90-0d7a-11e7-8e2d-ec70f9db0c1b.png) | ![night-skin](https://cloud.githubusercontent.com/assets/1376749/24115770/d61127f8-0d7a-11e7-9158-986bee2be8e7.png) | ![plum-skin](https://cloud.githubusercontent.com/assets/1376749/24115778/db523a0e-0d7a-11e7-9452-8692b736d67e.png) |
113
+
114
+ | `skin: sea` | `skin: soft` | `skin: steel` |
115
+ | --- | --- | --- |
116
+ | ![sea-skin](https://cloud.githubusercontent.com/assets/1376749/24115788/e27d818a-0d7a-11e7-8c56-2480e9ae83fb.png) | ![soft-skin](https://cloud.githubusercontent.com/assets/1376749/24115790/e6e548e8-0d7a-11e7-8e2d-d8053e8befd1.png) | ![steel-skin](https://cloud.githubusercontent.com/assets/1376749/24115799/eb2108e8-0d7a-11e7-8cc3-a6f22e4082ee.png) |
117
+
118
+ ### Google Fonts
119
+
120
+ This theme allows you to easily use [Google Fonts](https://fonts.google.com/)
121
+ throughout the theme. Simply add the following to your
122
+ [`/_data/theme.yml`](_data/theme.yml), replacing the font `name` and `weights`
123
+ accordingly.
124
+
125
+ ```yaml
126
+ google_fonts:
127
+ - name: "Fira Sans"
128
+ weights: "400,400i,600,600i"
129
+ - name: "Fira Sans Condensed"
130
+ ```
131
+
132
+ ### Text
133
+
134
+ To change text found throughout the theme add the following to your
135
+ [`/_data/theme.yml`](_data/theme.yml) file and customize as necessary.
136
+
137
+ ```yaml
138
+ t:
139
+ skip_links: "Skip links"
140
+ skip_primary_nav: "Skip to primary navigation"
141
+ skip_content: "Skip to content"
142
+ skip_footer: "Skip to footer"
143
+ menu: "Menu"
144
+ home: "Home"
145
+ newer: "Newer"
146
+ older: "Older"
147
+ email: "Email"
148
+ subscribe: "Subscribe"
149
+ read_more: "Read More"
150
+ posts: "Posts"
151
+ page: "Page"
152
+ of: "of"
153
+ min_read: "min read"
154
+ present: "Present"
155
+ ```
156
+
157
+ ### Navigation
158
+
159
+ By default all internal pages with a `title` will be added to the "off-canvas"
160
+ menu. For more granular control and sorting of these menu links:
161
+
162
+ 1. Create a custom list to override the default setting by adding a
163
+ `navigation_pages` array to your [`/_data/theme.yml`](_data/theme.yml) file.
164
+
165
+ 2. Add raw page paths in the order you'd like:
166
+
167
+ ```yaml
168
+ navigation_pages:
169
+ - about.md
170
+ - cv.md
171
+ ```
172
+
173
+ Each menu link's title and URL will be populated based on their `title` and
174
+ `permalink` respectively.
175
+
176
+ ### Pagination
177
+
178
+ Break up the main listing of posts into smaller lists and display them over
179
+ multiple pages by [enabling pagination](http://jekyllrb.com/docs/pagination/).
180
+
181
+ 1. Include the `jekyll-paginate` plugin in your `Gemfile`.
182
+
183
+ ```ruby
184
+ group :jekyll_plugins do
185
+ gem "jekyll-paginate"
186
+ end
187
+ ```
188
+
189
+ 2. Add `jekyll-paginate` to `gems` array in your `_config.yml` file and the
190
+ following pagination settings:
191
+
192
+ ```yaml
193
+ paginate: 5 # amount of posts to show per page
194
+ paginate_path: /page:num/
195
+ ```
196
+
197
+ 3. Create `index.html` (or rename `index.md`) in the root of your project and
198
+ add `layout: home` `paginate: true` to its YAML Front Matter.
199
+
200
+ ### Author
201
+
202
+ Author information is used as meta data for post "by lines" and propagates the
203
+ `creator` field of Twitter summary cards with the following YAML Front Matter
204
+ in `_config.yml`:
205
+
206
+ ```yaml
207
+ author:
208
+ name: John Doe
209
+ twitter: johndoetwitter
210
+ picture: /assets/images/johndoe.png
211
+ ```
212
+
213
+ Site-wide author information can be overridden in a document's YAML Front Matter
214
+ in the same way:
215
+
216
+ ```yaml
217
+ author:
218
+ name: Jane Doe
219
+ twitter: janedoetwitter
220
+ picture: /assets/images/janedoe.png
221
+ ```
222
+
223
+ Or by specifying a corresponding key in the document's YAML Front Matter, that
224
+ exists in `site.data.authors`. E.g., you have the following in the document's
225
+ YAML Front Matter:
226
+
227
+ ```yaml
228
+ author: megaman
229
+ ```
230
+
231
+ And you have the following in `_data/authors.yml`:
232
+
233
+ ```yaml
234
+ megaman:
235
+ name: Mega Man
236
+ twitter: megamantwitter
237
+ picture: /assets/images/megaman.png
238
+
239
+ drlight:
240
+ name: Dr. Light
241
+ twitter: drlighttwitter
242
+ picture: /assets/images/drlight.png
243
+ ```
244
+
245
+ Currently `author.picture` is only used in `layout: about`. Recommended size is
246
+ `300 x 300` pixels.
247
+
248
+ ### Reading Time
249
+
250
+ To enable reading time counts add `read_time: true` to a post or page's YAML
251
+ Front Matter.
252
+
253
+ ### Comments (via Disqus)
254
+
255
+ Optionally, if you have a [Disqus](https://disqus.com/) account, you can show a
256
+ comments section below each post.
257
+
258
+ To enable Disqus comments, add your [Disqus shortname](https://help.disqus.com/customer/portal/articles/466208) to your project's `_config.yml` file:
259
+
260
+ ```yaml
261
+ disqus:
262
+ shortname: my_disqus_shortname
263
+ ```
264
+
265
+ Comments are enabled by default and will only appear in production when built
266
+ with the following [environment value](http://jekyllrb.com/docs/configuration/#specifying-a-jekyll-environment-at-build-time):
267
+ `JEKYLL_ENV=production`
268
+
269
+ If you don't want to display comments for a particular post you can disable
270
+ them by adding `comments: false` to that post's YAML Front Matter.
271
+
272
+ ### Google Analytics
273
+
274
+ To enable Google Analytics, add your [tracking ID](https://support.google.com/analytics/answer/1032385)
275
+ to `_config.yml` like so:
276
+
277
+ ```yaml
278
+ google_analytics: UA-NNNNNNNN-N
279
+ ```
280
+
281
+ Similar to comments, the Google Analytics tracking script will only appear in
282
+ production when using the following environment value: `JEKYLL_ENV=production`.
283
+
284
+ ## Layouts
285
+
286
+ This theme provides the following layouts, which you can use by setting the
287
+ `layout` [Front Matter](https://jekyllrb.com/docs/frontmatter/) on each page,
288
+ like so:
289
+
290
+ ```yaml
291
+ ---
292
+ layout: name
293
+ ---
294
+ ```
295
+
296
+ ### `layout: default`
297
+
298
+ This layout handles all of the basic page scaffolding placing the page content
299
+ between the masthead and footer elements. All other layouts inherit this one
300
+ and provide additional styling and features inside of the `{{ content }}` block.
301
+
302
+ ### `layout: post`
303
+
304
+ This layout accommodates the following YAML Front Matter:
305
+
306
+ ```yaml
307
+ # optional alternate title to replace page.title at the top of the page
308
+ alt_title: "Basically Basic"
309
+
310
+ # optional sub-title below the page title
311
+ sub_title: "The name says it all"
312
+
313
+ # optional intro text below titles, Markdown allowed
314
+ introduction: |
315
+ Basically Basic is a Jekyll theme meant to be a substitute for the default --- [Minima](https://github.com/jekyll/minima). Conventions and features found in Minima are fully supported by **Basically Basic**.
316
+
317
+ # optional call to action links
318
+ actions:
319
+ - label: "Learn More"
320
+ icon: github # references name of svg icon, see full list below
321
+ url: "http://url-goes-here.com"
322
+ - label: "Download"
323
+ icon: download # references name of svg icon, see full list below
324
+ url: "http://url-goes-here.com"
325
+
326
+ image: # URL to a hero image associated with the post (e.g., /assets/page-pic.jpg)
327
+
328
+ # post specific author data if different from what is set in _config.yml
329
+ author:
330
+ name: John Doe
331
+ twitter: johndoetwitter
332
+
333
+ comments: false # disable comments on this post
334
+ ```
335
+
336
+ ### `layout: page`
337
+
338
+ Visually this layout looks and acts the same as `layout: post`, with two minor
339
+ differences.
340
+
341
+ - Author "by line" and publish date are omitted.
342
+ - Disqus comments are omitted.
343
+
344
+ ### `layout: home`
345
+
346
+ This layout accommodates the same YAML Front Matter as `layout: page`, with the
347
+ addition of the following:
348
+
349
+ ```yaml
350
+ paginate: true # enables pagination loop, see section above for additional setup
351
+ ```
352
+
353
+ ### `layout: about`
354
+
355
+ This layout accommodates the same YAML Front Matter as `layout: page`, with the
356
+ addition of the following to display an author picture:
357
+
358
+ ```yaml
359
+ author:
360
+ name: John Doe
361
+ picture /assets/images/johndoe.png
362
+ ```
363
+
364
+ Recommended `picture` size is approximately `300 x 300` pixels. If `author`
365
+ object is not explicitly set in the about page's YAML Front Matter the theme
366
+ will default to the value set in `_config.yml`.
367
+
368
+ If blank there no image will appear.
369
+
370
+ ### `layout: cv`
371
+
372
+ This layout accommodates the same YAML Front Matter as `layout: page`. It
373
+ leverages a [JSON-based file standard](https://jsonresume.org/schema/) for
374
+ resume data to conveniently render a curriculum vitæ or resume painlessly.
375
+
376
+ Simply use JSON Resume's [in-browser resume builder](http://registry.jsonresume.org/)
377
+ to export a JSON file and save to your project as `_data/cv.json`.
378
+
379
+ ## Customization
380
+
381
+ The default structure, style, and scripts of this theme can be overridden and
382
+ customized in the following two ways.
383
+
384
+ ### Overriding Includes and Layouts
385
+
386
+ Theme defaults can be [overridden](http://jekyllrb.com/docs/themes/#overriding-theme-defaults)
387
+ by placing a file with the same name into your project's `_includes` or
388
+ `_layouts` directory. For instance:
389
+
390
+ - To specify a custom style path or meta data to the [`_includes/head.html `](_includes/head.html)
391
+ file, create an `_includes` directory in your project, copy
392
+ `_includes/head.html` from Basically Basic's gem folder to
393
+ `<your_project>/_includes` and start editing that file.
394
+
395
+ **ProTip:** to locate the theme's files on your computer run
396
+ `bundle show jekyll-theme-basically-basic`. This returns the location of the
397
+ gem-based theme files.
398
+
399
+ ### Customizing Sass (SCSS)
400
+
401
+ To override the default [Sass](http://sass-lang.com/guide) (located in theme's
402
+ `_sass` directory), do one of the following:
403
+
404
+ 1. Copy directly from the Basically Basic gem
405
+
406
+ - Go to your local Basically Basic gem installation directory (run
407
+ `bundle show jekyll-theme-basically-basic` to get the path to it).
408
+ - Copy the contents of `/assets/stylesheets/main.scss` from there to
409
+ `<your_project>`.
410
+ - Customize want you want inside `<your_project>/assets/stylesheets/main.scss`.
411
+
412
+ 2. Copy from this repo.
413
+
414
+ - Copy the contents of [assets/stylesheets/main.scss](assets/stylesheets/main.scss)
415
+ to `<your_project>`.
416
+ - Customize want you want inside `<your_project/assets/stylesheets/main.scss`.
417
+
418
+ **Note:** To make more extensive changes and customize the Sass partials bundled
419
+ in the gem. You will need to copy the complete contents the `_sass` directory to
420
+ `<your_project>` due to the way Jekyll currently reads those files.
421
+
422
+ To make basic tweaks to theme's style Sass variables can be overridden by adding
423
+ to `<your_project>/assets/stylesheets/main.scss`. For instance, to change the
424
+ accent color used throughout the theme add:
425
+
426
+ ```scss
427
+ $accent-color: red;
428
+ ```
429
+
430
+ Before any `@import` lines.
431
+
432
+ ### Customizing JavaScript
433
+
434
+ To override the default JavaScript bundled in the theme, do one of the following:
435
+
436
+ 1. Copy directly from the Basically Basic gem
437
+
438
+ - Go to your local Basically Basic gem installation directory (run
439
+ `bundle show jekyll-theme-basically-basic` to get the path to it).
440
+ - Copy the contents of `/assets/javascripts/main.js` from there to
441
+ `<your_project>`.
442
+ - Customize what you want inside `<your_project>/assets/javascripts/main.js`.
443
+
444
+ 2. Copy from this repo.
445
+
446
+ - Copy the contents of [assets/javascripts/main.js](assets/javascripts/main.js)
447
+ to `<your_project>`.
448
+ - Customize what you want inside `<your_project>/assets/javascripts/main.js`.
449
+
450
+ ### SVG Icons
451
+
452
+ The theme uses social network logos and other iconography saved as SVGs for
453
+ performance and flexibility. Said SVGs are located in the `_includes` directory
454
+ and prefixed with `icon-`. Each icon has been sized and designed to fit a
455
+ `16 x 16` viewbox and optimized with [SVGO](https://github.com/svg/svgo).
456
+
457
+ Fill colors are defined in the `_sass/basically-basic/_icons.scss` partial and
458
+ set with `.icon-name` where class name matches the corresponding icon.
459
+
460
+ For example the Twitter icon is given a fill color of `#1da1f2` like so:
461
+
462
+ ```html
463
+ <span class="icon icon--twitter">{% include icon-twitter.svg %}</span>
464
+ ```
465
+
466
+ Alongside the SVG assets, there are icon helper includes to aid in generating
467
+ social network links.
468
+
469
+ | Include Parameter | Description | Required |
470
+ | ----------------- | ---------------------------------| ----------------------- |
471
+ | `username` | Username on given social network | **Required** |
472
+ | `label` | Text used for hyperlink | Optional, defaults to `username` |
473
+
474
+ For example, the following `icon-github.html` include:
475
+
476
+ ```liquid
477
+ {% include icon-github.html username=jekyll label='GitHub' %}
478
+ ```
479
+
480
+ Will output the following HTML:
481
+
482
+ ```html
483
+ <a href="https://github.com/jekyll">
484
+ <span class="icon icon--github"><svg viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.414"><path d="M8 0C3.58 0 0 3.582 0 8c0 3.535 2.292 6.533 5.47 7.59.4.075.547-.172.547-.385 0-.19-.007-.693-.01-1.36-2.226.483-2.695-1.073-2.695-1.073-.364-.924-.89-1.17-.89-1.17-.725-.496.056-.486.056-.486.803.056 1.225.824 1.225.824.714 1.223 1.873.87 2.33.665.072-.517.278-.87.507-1.07-1.777-.2-3.644-.888-3.644-3.953 0-.873.31-1.587.823-2.147-.09-.202-.36-1.015.07-2.117 0 0 .67-.215 2.2.82.64-.178 1.32-.266 2-.27.68.004 1.36.092 2 .27 1.52-1.035 2.19-.82 2.19-.82.43 1.102.16 1.915.08 2.117.51.56.82 1.274.82 2.147 0 3.073-1.87 3.75-3.65 3.947.28.24.54.73.54 1.48 0 1.07-.01 1.93-.01 2.19 0 .21.14.46.55.38C13.71 14.53 16 11.53 16 8c0-4.418-3.582-8-8-8"></path></svg></span>
485
+ <span class="label">GitHub</span>
486
+ </a>
487
+ ```
488
+
489
+ ### Customizing Sidebar Content
490
+
491
+ ---
492
+
493
+ ## Development
494
+
495
+ To set up your environment to develop this theme:
496
+
497
+ 1. Clone this repo
498
+ 2. `cd` into `/example` and run `bundle install`.
499
+
500
+ To test the theme the locally as you make changes to it:
501
+
502
+ 1. `cd` into the root folder of the repo (e.g. `jekyll-theme-basically-basic`).
503
+ 2. Run `bundle exec rake preview` and open your browser to
504
+ `http://localhost:4000/example/`.
505
+
506
+ This starts a Jekyll server using the theme's files and contents of the
507
+ `example/` directory. As modifications are made, refresh your browser to see
508
+ any changes.
509
+
510
+ ## Contributing
511
+
512
+ Found a typo in the documentation? Interested in adding a feature or
513
+ [fixing a bug][issues]? Then by all means [submit an issue][new-issue] or take a
514
+ stab at submitting a [pull request][using-pull-requests]. If this is your first
515
+ pull request, it may be helpful to read up on the [GitHub Flow][github-flow].
516
+
517
+ [issues]: https://github.com/mmistakes/jekyll-theme-basically-basic/issues
518
+ [new-issue]: https://github.com/mmistakes/jekyll-theme-basically-basic/issues/new
519
+ [using-pull-requests]: https://help.github.com/articles/using-pull-requests/
520
+ [github-flow]: https://guides.github.com/introduction/flow/
521
+
522
+ ### Pull Requests
523
+
524
+ When submitting a pull request:
525
+
526
+ 1. Clone the repo.
527
+ 2. Create a branch off of `master` and give it a meaningful name (e.g.
528
+ `my-awesome-new-feature`) and describe the feature or fix.
529
+ 3. Open a pull request on GitHub.
530
+
531
+ Sample pages can be found in the [`/docs`](docs) folder if you'd like to tackle
532
+ any "low-hanging fruit" like fixing typos, bad grammar, etc.
533
+
534
+ ---
535
+
536
+ ## Credits
537
+
538
+ ### Creator
539
+
540
+ **Michael Rose**
541
+
542
+ - <https://mademistakes.com>
543
+ - <https://twitter.com/mmistakes>
544
+ - <https://github.com/mmistakes>
545
+
546
+ ### Icons + Demo Images:
547
+
548
+ - [Simple Icons](https://simpleicons.org/)
549
+ - [Noun Project](https://thenounproject.com)
550
+ - [Unsplash](https://unsplash.com/)
551
+
552
+ ### Other:
553
+
554
+ - [Jekyll](http://jekyllrb.com/)
555
+ - [Susy](http://susy.oddbird.net/)
556
+ - [Breakpoint](http://breakpoint-sass.com/)
557
+
558
+ ---
559
+
560
+ ## License
561
+
562
+ The MIT License (MIT)
563
+
564
+ Copyright (c) 2017 Michael Rose
565
+
566
+ Permission is hereby granted, free of charge, to any person obtaining a copy
567
+ of this software and associated documentation files (the "Software"), to deal
568
+ in the Software without restriction, including without limitation the rights
569
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
570
+ copies of the Software, and to permit persons to whom the Software is
571
+ furnished to do so, subject to the following conditions:
572
+
573
+ The above copyright notice and this permission notice shall be included in all
574
+ copies or substantial portions of the Software.
575
+
576
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
577
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
578
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
579
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
580
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
581
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
582
+ SOFTWARE.