Skip to content

Commit

Permalink
Add installation guide on GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
kamikat committed May 11, 2017
1 parent 46e441d commit f3f50d5
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,19 @@ Or install it yourself as:
$ gem install jekyll-theme-kagami
### GitHub Pages
Jekyll build is integrated with GitHub Pages with limited function. This section is intended for those who
want to use the theme with GitHub Pages hosted sites.
1. Download latest gem file from https://rubygems.org/gems/jekyll-theme-kagami
2. Run `gem unpack [path-to-downloaded-gem-file] --target=.` on jekyll site project folder
3. Delete the line `theme: ...` in `_config.yml`

Zip archive downloaded from release page may not work because GitHub does not pack necessary files from submodules.

Instruction 1 and 2 can also work when you decide to upgrade your installation.

## Usage

### Social account links
Expand Down

0 comments on commit f3f50d5

Please sign in to comment.