Skip to content

Commit

Permalink
Update README (#12)
Browse files Browse the repository at this point in the history
* Install via remote_theme

* Update header_pages and attach links to plugins

* Attach link to remote_theme

https://github.com/benbalter/jekyll-remote-theme
  • Loading branch information
toshimaru authored May 3, 2022
1 parent 21a45c3 commit c7b941f
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ jekyll-theme-classless-simple is a Jekyll theme styled with [Simple.css](https:/

## Installation

### via [remote_theme](https://github.com/benbalter/jekyll-remote-theme)

Add this line to your Jekyll site's `_config.yml`:

```yml
remote_theme: toshimaru/jekyll-theme-classless-simple
```
### via gem
Add this line to your Jekyll site's `Gemfile`:

```ruby
Expand All @@ -31,7 +41,9 @@ $ bundle

```yml
# Specify theme
theme: jekyll-theme-classless-simple
remote_theme: toshimaru/jekyll-theme-classless-simple
# Or if you install gem,
# theme: jekyll-theme-classless-simple
classless-simple:
syntax: monokai # syntax highlight theme
Expand All @@ -41,16 +53,17 @@ google_analytics: UA-XXX
# Navigation links in header
header_pages:
- home.md
- about.md
- view-on-github.md
```
- categories.html
```

## Plugins

This theme depends on:

- jekyll-seo-tag
- jekyll-feed
- [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag)
- [jekyll-feed](https://github.com/jekyll/jekyll-feed)

## Contributing

Expand Down

0 comments on commit c7b941f

Please # to comment.