Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
b2a3e8 committed Jun 19, 2020
1 parent bf230ea commit 9b8ac66
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ First, follow the steps in [this Quickstart Guide](https://jekyllrb.com/docs/) i
Use this method for sites hosted with GitHub Pages only. To install:

1. Set `remote_theme` in your project's Jekyll `_config.yml` file:

```yaml
remote_theme: b2a3e8/jekyll-theme-console
```
Expand All @@ -32,7 +32,7 @@ With Gem-based themes, directories such as the `assets`, `_layouts`, `_includes`
This allows for easier installation and updating as you don't have to manage any of the theme files. To install:

1. Add this line to your Jekyll site's `Gemfile`:

```ruby
gem "jekyll-theme-console"
```
Expand All @@ -44,15 +44,17 @@ This allows for easier installation and updating as you don't have to manage any
```

3. Set `theme` in your project's Jekyll `_config.yml` file:

```yaml
theme: jekyll-theme-console
```

To update the theme run `bundle update`.

## Usage

### _config.yaml

In addition to jekyll's default configuration options, you can provide:
- `header_pages` to specify which pages should be displayed in navbar
- `footer` string, which will be inserted on the end of the page (doesn't support markup, but html)
Expand All @@ -72,6 +74,13 @@ footer: 'follow us on <a href="https://twitter.com/xxx">twitter</a>'
google_analytics: UA-NNNNNNNN-N
```

### front matter variables

Besides the predefined [front matter](https://jekyllrb.com/docs/front-matter/) variables from jekyll this theme also supports following variables:
- `title` to set a title for the page
- `lang` to specify the language, defaults to 'en'
- `robots` to control the robot meta tag ([details](http://longqian.me/2017/02/12/jekyll-robots-configuration/)) - this may be useful for example to set `NOINDEX` to tag pages

## Customization

If you want to customize this theme, follow this steps:
Expand Down
2 changes: 1 addition & 1 deletion jekyll-theme-console.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Gem::Specification.new do |spec|
spec.name = "jekyll-theme-console"
spec.version = "0.3.7"
spec.version = "0.3.8"
spec.authors = ["b2a3e8"]
spec.email = ["[email protected]"]

Expand Down

0 comments on commit 9b8ac66

Please sign in to comment.