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
If you're running Jekyll v3.3+ and self-hosting you can quickly install the
62
-
theme as Ruby gem. If you're hosting with GitHub Pages you'll have to use the
63
-
"repo fork" method or directly copy all of the theme files (see
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
64
72
[structure](#structure) below) into your project.
65
73
66
74
### Ruby Gem Method
67
75
68
-
1.Install the theme as a Ruby Gem by adding it to your `Gemfile` like so:
76
+
1.Add this line to your Jekyll site's `Gemfile`:
69
77
70
78
```ruby
71
79
gem "jekyll-theme-basically-basic"
72
80
```
73
-
74
-
2. Fetch and update your bundled gems by running the following
75
-
[Bundler](http://bundler.io/) command:
76
-
77
-
```bash
78
-
bundle
79
-
```
80
-
81
-
3. Set the `theme` in your project's Jekyll configuration, `_config.yml`:
81
+
2. Add this line to your Jekyll site's `_config.yml` file:
82
82
83
83
```yaml
84
84
theme: jekyll-theme-basically-basic
85
85
```
86
86
87
-
### GitHub Pages Method
88
-
89
-
If you're hosting with GitHub Pages follow these steps instead:
87
+
2. Then run [Bundler](http://bundler.io/) to install the theme gem and dependencies:
88
+
89
+
```terminal
90
+
bundle install
91
+
```
90
92
91
-
Replace `gem "jekyll"` with:
93
+
### GitHub Pages Method
92
94
93
-
```ruby
94
-
gem "github-pages", group: :jekyll_plugins
95
-
```
95
+
GitHub Pages has added [full support](https://github.com/blog/2464-use-any-theme-with-github-pages) for any GitHub-hosted theme.
96
96
97
-
Run `bundle update` and verify that all gems install properly.
97
+
1. Replace `gem "jekyll"` with:
98
98
99
-
Add `remote_theme: "mmistakes/jekyll-theme-basically-basic"` to your `_config.yml` file.
99
+
```ruby
100
+
gem "github-pages", group::jekyll_plugins
101
+
```
100
102
101
-
Then add [`jekyll-remote-theme`](https://github.com/benbalter/jekyll-remote-theme) to the `plugins` (previously gems) array in your `_config.yml` file like so:
103
+
2. Run `bundle update` and verify that all gems install properly.
102
104
103
-
```yaml
104
-
plugins:
105
-
- jekyll-remote-theme
106
-
```
105
+
3. Add `remote_theme: "mmistakes/jekyll-theme-basically-basic"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entries.
107
106
108
-
Remove any other `theme:` or `remote_theme:` entry.
107
+
---
109
108
110
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).
111
110
@@ -130,6 +129,78 @@ safely remove the following files and folders:
130
129
-`/docs`
131
130
-`/example`
132
131
132
+
## Upgrading
133
+
134
+
If you're using the Ruby Gem or remote theme versions of Basically Basic, upgrading is fairly painless.
135
+
136
+
To check which version you are currently using, view the source of your built site and you should something similar to:
137
+
138
+
```
139
+
<!--
140
+
Basically Basic Jekyll Theme 1.2.0
141
+
Copyright 2017-2018 Michael Rose - mademistakes.com | @mmistakes
142
+
Free for personal and commercial use under the MIT license
At the top of every `.html` file, `/assets/css/main.css`, and `/assets/js/main.js`.
148
+
149
+
## Ruby Gem
150
+
151
+
Simply run `bundle update` if you're using Bundler (have a `Gemfile`) or `gem update jekyll-theme-basically-basic` if you're not.
152
+
153
+
## Remote Theme
154
+
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).
156
+
157
+
An empty commit will get the job done too if you don't have anything to push at the moment:
158
+
159
+
```terminal
160
+
git commit --allow-empty -m "Force rebuild of site"
161
+
```
162
+
163
+
## Use Git
164
+
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.
166
+
167
+
To double check, run `git remote -v` and verify that you can fetch from `origin https://github.com/mmistakes/jekyll-theme-basically-basic.git`.
Now you can pull any commits made to theme's `master` branch with:
178
+
179
+
```terminal
180
+
git pull upstream master
181
+
```
182
+
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.
184
+
185
+
## Update Files Manually
186
+
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.
188
+
189
+
Here's a quick checklist of the important folders/files you'll want to be mindful of:
190
+
191
+
| Name ||
192
+
| ---- | --- |
193
+
|`_layouts`| Replace all. Apply edits if you customized any layouts. |
194
+
|`_includes`| Replace all. Apply edits if you customized any includes. |
195
+
|`assets`| Replace all. Apply edits if you customized stylesheets or scripts. |
196
+
|`_sass`| Replace all. Apply edits if you customized Sass partials. |
197
+
|`_data/theme.yml`| Safe to keep. Verify that there were no major structural changes or additions. |
198
+
|`_config.yml`| Safe to keep. Verify that there were no major structural changes or additions. |
199
+
200
+
---
201
+
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.min.js`, or `*.html` may be cached.
203
+
133
204
## Structure
134
205
135
206
Layouts, includes, Sass partials, and data files are all placed in their default
@@ -140,7 +211,7 @@ files in the project's root directory.
140
211
files found in `/_layouts`, `/_includes`, `/_sass`, and `/assets` will be
141
212
missing. This is normal as they are bundled with the [`jekyll-theme-basically-basic`](https://rubygems.org/gems/jekyll-theme-basically-basic) gem.
0 commit comments