diff --git a/README.md b/README.md index 381b5b9b6..d5b470f17 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -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" ``` @@ -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) @@ -72,6 +74,13 @@ footer: 'follow us on twitter' 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: diff --git a/jekyll-theme-console.gemspec b/jekyll-theme-console.gemspec index 4371f5b33..cd3933e17 100644 --- a/jekyll-theme-console.gemspec +++ b/jekyll-theme-console.gemspec @@ -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 = ["31370519+b2a3e8@users.noreply.github.com"]