Skip to content

Commit d716ba9

Browse files
authored
update README (#72)
1 parent 0510c5d commit d716ba9

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ gem 'jekyll-dash', '~> 1.0.0'
2525
2626
For **Jekyll 4**:
2727
```ruby
28-
gem 'jekyll-dash', '~> 2.0.0'
28+
gem 'jekyll-dash', '~> 2.1.0'
2929
```
3030

3131
And add this line to your Jekyll site's `_config.yml`:
@@ -86,12 +86,9 @@ dash:
8686
```
8787
## Using this theme directly on Github Pages
8888

89-
Please keep in mind that Github Pages does only support [a limited list of Jekyll plugins](https://pages.github.com/versions/). You will be able to use this theme on Github Pages but some functionality might not be available, for example displaying tags. In order to use this theme to a full extend, you have to generate the `_site` externally, for example on [TravisCI](https://travis-ci.org).
89+
Please keep in mind that Github Pages does only support [a limited list of Jekyll plugins](https://pages.github.com/versions/). You will be able to use this theme on Github Pages but some functionality might not be available, for example displaying tags. In order to use this theme to a full extend, you have to generate the `_site` [separately via Github Actions](https://jekyllrb.com/docs/continuous-integration/github-actions/).
9090

91-
For example, you want to host your own blog on `https://<username>.github.io`. As a result, you require the following repositories:
92-
93-
* `blog` - contains the actual Jekyll sources ([see example](https://github.com/bitbrain/blog))
94-
* `<username>.github.io` - contains generated webpage, pushed automatically via TravisCI ([see example](https://github.com/bitbrain/bitbrain.github.io))
91+
* `<username>.github.io` - contains main source branch and orphan gh-pages branch ([see example](https://github.com/bitbrain/bitbrain.github.io))
9592

9693
You are not required to do this, but keep in mind that some functionality might not be available when using the Jekyll generator on Github directly!
9794

0 commit comments

Comments
 (0)