Skip to content

Commit 03290c3

Browse files
authored
Update README.md
1 parent 982ed8d commit 03290c3

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,16 @@ dash:
6868
icon: github-square
6969
color: purple
7070
```
71+
## Using this theme directly on Github Pages
72+
73+
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).
74+
75+
For example, you want to host your own blog on `https://<username>.github.io`. As a result, you require the following repositories:
76+
77+
* `blog` - contains the actual Jekyll sources ([see example](https://github.com/bitbrain/blog))
78+
* `<username>.github.io` - contains generated webpage, pushed automatically via TravisCI ([see example](https://github.com/bitbrain/bitbrain.github.io))
79+
80+
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!
7181

7282
## Additional Features
7383

0 commit comments

Comments
 (0)