Skip to content

Commit 98b82c0

Browse files
committed
Update GitHub Pages compatible installation instructions
Replace old fork method with jekyll-remote-theme method.
1 parent 21bb1ed commit 98b82c0

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -87,25 +87,29 @@ theme as Ruby gem. If you're hosting with GitHub Pages you'll have to use the
8787
8888
### GitHub Pages Compatible Method
8989
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.
90+
If you're hosting with GitHub Pages follow these steps instead:
9391
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:
92+
Replace `gem "jekyll"` with:
10093

10194
```ruby
102-
source "https://rubygems.org"
103-
10495
gem "github-pages", group: :jekyll_plugins
96+
gem "jekyll-remote-theme"
10597
```
10698

107-
Then run `bundle update` and verify that the [GitHub Pages gem](https://github.com/github/pages-gem)
108-
and its dependencies install properly.
99+
Run `bundle update` and verify that all gems install properly.
100+
101+
Add `remote_theme: "mmistakes/jekyll-theme-basically-basic"` to your `_config.yml` file.
102+
103+
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:
104+
105+
```yaml
106+
plugins:
107+
- jekyll-remote-theme
108+
```
109+
110+
**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+
112+
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/).
109113

110114
#### Remove the Unnecessary
111115

0 commit comments

Comments
 (0)