aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: d57ecf9ac08f561466bf4f2e81f2c2818b766363 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# nazaryev-blog

Welcome to your new Jekyll theme! In this directory, you'll find the files you
need to be able to package up your theme into a gem. Put your layouts in
`_layouts`, your includes in `_includes` and your sass in `_sass`. To
experiment with this code, add some sample content and run `bundle exec jekyll
serve` – this directory is setup just like a Jekyll site!

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your Jekyll site's Gemfile:

```ruby gem "nazaryev-blog" ```

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

```yaml theme: nazaryev-blog ```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install nazaryev-blog

## Usage

TODO: Write usage instructions here. Describe your available layouts, includes,
and/or sass.

## Contributing

Bug reports and pull requests are welcome on GitHub at
https://github.com/[USERNAME]/hello. This project is intended to be a safe,
welcoming space for collaboration, and contributors are expected to adhere to
the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## Development

To set up your environment to develop this theme, run `bundle install`.

You theme is setup just like a normal Jelyll site! To test your theme, run
`bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
This starts a Jekyll server using your theme. Add pages, documents, data, etc.
like normal to test your theme's contents. As you make modifications to your
theme and to your content, your site will regenerate and you should see the
changes in the browser after a refresh, just like normal.

When your theme is released, only the files in `_layouts`, `_includes`, and
`_sass` tracked with Git will be released.

## License

The theme is available as open source under the terms of the [MIT
License](http://opensource.org/licenses/MIT).