You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+48-22Lines changed: 48 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,8 +68,10 @@ with a few enhancements thrown in for good measure:
68
68
69
69
## Installation
70
70
71
-
If you're running Jekyll v3.5+ and self-hosting you can quickly install the theme as a Ruby gem. If you're hosting with GitHub Pages you can install as a remote theme or directly copy all of the theme files (see
72
-
[structure](#structure) below) into your project.
71
+
If you're running Jekyll v3.5+ and self-hosting you can quickly install the
72
+
theme as a Ruby gem. If you're hosting with GitHub Pages you can install as a
73
+
remote theme or directly copy all of the theme files (see [structure](#structure)
74
+
below) into your project.
73
75
74
76
### Ruby Gem Method
75
77
@@ -92,7 +94,8 @@ If you're running Jekyll v3.5+ and self-hosting you can quickly install the them
92
94
93
95
### GitHub Pages Method
94
96
95
-
GitHub Pages has added [full support](https://github.com/blog/2464-use-any-theme-with-github-pages) for any GitHub-hosted theme.
97
+
GitHub Pages has added [full support](https://github.com/blog/2464-use-any-theme-with-github-pages)
98
+
for any GitHub-hosted theme.
96
99
97
100
1. Replace `gem "jekyll"` with:
98
101
@@ -102,13 +105,20 @@ GitHub Pages has added [full support](https://github.com/blog/2464-use-any-theme
102
105
103
106
2. Run `bundle update` and verify that all gems install properly.
104
107
105
-
3. Add `remote_theme: "mmistakes/jekyll-theme-basically-basic"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entries.
108
+
3. Add `remote_theme: "mmistakes/jekyll-theme-basically-basic"` to your
109
+
`_config.yml` file. Remove any other `theme:` or `remote_theme:` entries.
106
110
107
111
---
108
112
109
-
**Note:** Your Jekyll site should be viewable immediately at <http://USERNAME.github.io>. If it's not, you can force a rebuild by **Customizing Your Site** (see below for more details).
113
+
**Note:** Your Jekyll site should be viewable immediately at
114
+
<http://USERNAME.github.io>. If it's not, you can force a rebuild by
115
+
**Customizing Your Site** (see below for more details).
110
116
111
-
If you're hosting several Jekyll based sites under the same GitHub username you will have to use Project Pages instead of User Pages. Essentially you rename the repo to something other than **USERNAME.github.io** and create a `gh-pages` branch off of `master`. For more details on how to set things up check [GitHub's documentation](https://help.github.com/articles/user-organization-and-project-pages/).
117
+
If you're hosting several Jekyll based sites under the same GitHub username you
118
+
will have to use Project Pages instead of User Pages. Essentially you rename the
119
+
repo to something other than **USERNAME.github.io** and create a `gh-pages`
120
+
branch off of `master`. For more details on how to set things up check
@@ -131,9 +141,11 @@ safely remove the following files and folders:
131
141
132
142
## Upgrading
133
143
134
-
If you're using the Ruby Gem or remote theme versions of Basically Basic, upgrading is fairly painless.
144
+
If you're using the Ruby Gem or remote theme versions of Basically Basic,
145
+
upgrading is fairly painless.
135
146
136
-
To check which version you are currently using, view the source of your built site and you should something similar to:
147
+
To check which version you are currently using, view the source of your built
148
+
site and you should something similar to:
137
149
138
150
```
139
151
<!--
@@ -148,21 +160,27 @@ At the top of every `.html` file, `/assets/css/main.css`, and `/assets/js/main.j
148
160
149
161
## Ruby Gem
150
162
151
-
Simply run `bundle update` if you're using Bundler (have a `Gemfile`) or `gem update jekyll-theme-basically-basic` if you're not.
163
+
Simply run `bundle update` if you're using Bundler (have a `Gemfile`) or `gem
164
+
update jekyll-theme-basically-basic` if you're not.
152
165
153
166
## Remote Theme
154
167
155
-
When hosting with GitHub Pages you'll need to push up a commit to force a rebuild with the latest [theme release](https://github.com/mmistakes/jekyll-theme-basically-basic/releases).
168
+
When hosting with GitHub Pages you'll need to push up a commit to force a
169
+
rebuild with the latest [theme release](https://github.com/mmistakes/jekyll-theme-basically-basic/releases).
156
170
157
-
An empty commit will get the job done too if you don't have anything to push at the moment:
171
+
An empty commit will get the job done too if you don't have anything to push at
172
+
the moment:
158
173
159
174
```terminal
160
175
git commit --allow-empty -m "Force rebuild of site"
161
176
```
162
177
163
178
## Use Git
164
179
165
-
If you want to get the most out of the Jekyll + GitHub Pages workflow, then you'll need to utilize Git. To pull down theme updates you must first ensure there's an upstream remote. If you forked the theme's repo then you're likely good to go.
180
+
If you want to get the most out of the Jekyll + GitHub Pages workflow, then
181
+
you'll need to utilize Git. To pull down theme updates you must first ensure
182
+
there's an upstream remote. If you forked the theme's repo then you're likely
183
+
good to go.
166
184
167
185
To double check, run `git remote -v` and verify that you can fetch from `origin https://github.com/mmistakes/jekyll-theme-basically-basic.git`.
168
186
@@ -180,13 +198,20 @@ Now you can pull any commits made to theme's `master` branch with:
180
198
git pull upstream master
181
199
```
182
200
183
-
Depending on the amount of customizations you've made after forking, there's likely to be merge conflicts. Work through any conflicting files Git flags, staging the changes you wish to keep, and then commit them.
201
+
Depending on the amount of customizations you've made after forking, there's
202
+
likely to be merge conflicts. Work through any conflicting files Git flags,
203
+
staging the changes you wish to keep, and then commit them.
184
204
185
205
## Update Files Manually
186
206
187
-
Another way of dealing with updates is [downloading the theme](https://github.com/mmistakes/jekyll-theme-basically-basic/archive/master.zip) --- replacing your layouts, includes, and assets with the newer ones manually. To be sure that you don't miss any changes it's probably a good idea to review the theme's [commit history](https://github.com/mmistakes/jekyll-theme-basically-basic/commits/master) to see what's changed since.
207
+
Another way of dealing with updates is [downloading the theme](https://github.com/mmistakes/jekyll-theme-basically-basic/archive/master.zip)
208
+
--- replacing your layouts, includes, and assets with the newer ones manually.
209
+
To be sure that you don't miss any changes it's probably a good idea to review
210
+
the theme's [commit history](https://github.com/mmistakes/jekyll-theme-basically-basic/commits/master)
211
+
to see what's changed since.
188
212
189
-
Here's a quick checklist of the important folders/files you'll want to be mindful of:
213
+
Here's a quick checklist of the important folders/files you'll want to be
214
+
mindful of:
190
215
191
216
| Name ||
192
217
| ---- | --- |
@@ -199,7 +224,9 @@ Here's a quick checklist of the important folders/files you'll want to be mindfu
199
224
200
225
---
201
226
202
-
**Note:** If you're not seeing the latest version, be sure to flush browser and CDN caches. Depending on your hosting environment older versions of `/assets/css/main.css`, `/assets/js/main.js`, or `*.html` may be cached.
227
+
**Note:** If you're not seeing the latest version, be sure to flush browser and
228
+
CDN caches. Depending on your hosting environment older versions of
229
+
`/assets/css/main.css`, `/assets/js/main.js`, or `*.html` may be cached.
203
230
204
231
## Structure
205
232
@@ -431,7 +458,8 @@ Front Matter.
431
458
Optionally, if you have a [Disqus](https://disqus.com/) account, you can show a
432
459
comments section below each post.
433
460
434
-
To enable Disqus comments, add your [Disqus shortname](https://help.disqus.com/customer/portal/articles/466208) to your project's `_config.yml` file:
461
+
To enable Disqus comments, add your [Disqus shortname](https://help.disqus.com/customer/portal/articles/466208) to your project's
462
+
`_config.yml` file:
435
463
436
464
```yaml
437
465
disqus:
@@ -592,19 +620,17 @@ To override the default [Sass](http://sass-lang.com/guide) (located in theme's
592
620
- Customize what you want inside `<your_project/assets/stylesheets/main.scss`.
593
621
594
622
**Note:** To make more extensive changes and customize the Sass partials bundled
595
-
in the gem. You will need to copy the complete contents the `_sass` directory to
596
-
`<your_project>`due to the way Jekyll currently reads those files.
623
+
in the gem. You will need to copy the complete contents of the `_sass` directory
624
+
to `<your_project>` due to the way Jekyll currently reads those files.
597
625
598
626
To make basic tweaks to theme's style Sass variables can be overridden by adding
599
627
to `<your_project>/assets/stylesheets/main.scss`. For instance, to change the
600
-
accent color used throughout the theme add:
628
+
accent color used throughout the theme add the following:
601
629
602
630
```scss
603
631
$accent-color: red;
604
632
```
605
633
606
-
Before any `@import` lines.
607
-
608
634
### Customizing JavaScript
609
635
610
636
To override the default JavaScript bundled in the theme, do one of the following:
0 commit comments