Sha256: 521300df81e869cdbb38a1db49b42a15d95f7f0a8b848ee6a3240135f68cb6de

Contents?: true

Size: 1.5 KB

Versions: 5

Compression:

Stored size: 1.5 KB

Contents

# Jekyll Wedding Theme

Welcome to the Jekyll Wedding Theme! This theme is supposed to be used for
creating a Jekyll website for your wedding.

## Installation

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

```ruby
gem "jekyll-wedding"
```

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

```yaml
theme: jekyll-wedding
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install jekyll-wedding

## Usage

TODO

## Contributing

Bug reports and pull requests are welcome on GitHub at
https://github.com/apfohl/jekyll-wedding. 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`.

Your theme is setup just like a normal Jekyll 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](https://opensource.org/licenses/MIT).

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
jekyll-wedding-0.5.0 README.md
jekyll-wedding-0.4.0 README.md
jekyll-wedding-0.3.0 README.md
jekyll-wedding-0.2.0 README.md
jekyll-wedding-0.1.0 README.md