Sha256: d71b6c87c2bbedbc9b3e71ae88827efb548aad83ae62121ede020d38d28ff3ce

Contents?: true

Size: 1.95 KB

Versions: 1

Compression:

Stored size: 1.95 KB

Contents

# wax_theme 🐝

[![Gem Version](https://badge.fury.io/rb/wax_theme.svg)](https://badge.fury.io/rb/wax_tasks) ![License](https://img.shields.io/badge/license-MIT-yellowgreen.svg) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![docs](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/github/mnyrop/wax_tasks/)

[![Build Status](https://travis-ci.org/mnyrop/wax_theme.svg?branch=rubocop)](https://travis-ci.org/mnyrop/wax_theme) [![](https://img.shields.io/librariesio/github/mnyrop/wax_theme.svg)](https://libraries.io/github/mnyrop/wax_theme)

__wax_theme__ is a gem packaged [Jekyll](https://jekyllrb.com/) theme for [Minicomp/Wax](https://github.com/minicomp/wax/).

It includes components specifically tailored for minimal scholarly exhibition sites, including IIIF and flat image viewers, faceted galleries, parallax banners, dynamic search boxes, data tables, and more.

For a demo, visit https://minicomp.github.io/wax/.

<a href="https://minicomp.github.io/wax/">
  <img src="https://raw.githubusercontent.com/minicomp/wiki/master/docs/assets/wax_screen.gif"/>
</a>

## Installation

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

```ruby
gem "wax_theme"
```

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

```yaml
theme: wax_theme
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install wax_theme

## Usage

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

## Contributing

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

## License

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

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
wax_theme-0.1.0.beta README.md