An open API service indexing awesome lists of open source software.

https://github.com/helpscout/jekyll-spark

Spark ✨: A Jekyll library for building component-based UI templates
https://github.com/helpscout/jekyll-spark

components jekyll open-source ruby

Last synced: about 1 year ago
JSON representation

Spark ✨: A Jekyll library for building component-based UI templates

Awesome Lists containing this project

README

          

# Spark ✨ [![Build Status](https://travis-ci.org/helpscout/jekyll-spark.svg?branch=master)](https://travis-ci.org/helpscout/jekyll-spark) [![Gem Version](https://badge.fury.io/rb/jekyll-spark.svg)](https://badge.fury.io/rb/jekyll-spark) [![Coverage Status](https://coveralls.io/repos/github/helpscout/jekyll-spark/badge.svg?branch=master)](https://coveralls.io/github/helpscout/jekyll-spark?branch=master)

A Jekyll library for building fast component-based UI.

This library was heavily inspired by view/component creation from modern Javascript libraries like [React](https://facebook.github.io/react/) and [Vue](https://vuejs.org/).

**Table of Contents**

- [Install](#install)
- [Documentation](#documenation)
- [Examples](#examples)

## Install

Add this line to your application's Gemfile:

```ruby
gem 'jekyll-spark'
```

And then execute:
```
bundle
```

Or install it yourself as:
```
gem install jekyll-spark
```

## Documentation

**[View the docs](https://github.com/helpscout/jekyll-spark/blob/master/docs/introduction.md)** to get started with Jekyll Components!

## Examples

**[View the starter](https://github.com/helpscout/jekyll-spark/tree/master/examples)** Component view files.