Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
b2a3e8 authored Jan 22, 2020
1 parent 16ca815 commit 53290be
Showing 1 changed file with 30 additions and 12 deletions.
42 changes: 30 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,43 @@ source code: [https://github.com/b2a3e8/jekyll-theme-console/tree/gh-pages](http

## Installation

Add this line to your Jekyll site's `Gemfile`:
First, follow the steps in [this Quickstart Guide](https://jekyllrb.com/docs/) if you're starting with Jekyll from scratch. Skip this if you already have an existing jekyll project.

```ruby
gem "jekyll-theme-console"
```
### Remote theme method for GitHub Pages

And add this line to your Jekyll site's `_config.yml`:
Use this method for sites hosted with GitHub Pages only. To install:

```yaml
theme: jekyll-theme-console
```
1. Set `remote_theme` in your project's Jekyll `_config.yml` file:

```yaml
remote_theme: b2a3e8/jekyll-theme-console
```
### Gem-based method
With Gem-based themes, directories such as the `assets`, `_layouts`, `_includes`, and `_sass` are stored in the theme’s gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll’s build process.

This allows for easier installation and updating as you don't have to manage any of the theme files. To install:

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

```ruby
gem "jekyll-theme-console"
```

$ bundle
2. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command:

Or install it yourself as:
```bash
bundle
```

$ gem install jekyll-theme-console
3. Set `theme` in your project's Jekyll `_config.yml` file:

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

To update the theme run `bundle update`.

## Usage

Expand Down

0 comments on commit 53290be

Please sign in to comment.