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

A Jekyll library for building component-based UI
https://github.com/helpscout/jekyll-components

components deprecated jekyll open-source

Last synced: 3 months ago
JSON representation

A Jekyll library for building component-based UI

• Host: GitHub
• URL: https://github.com/helpscout/jekyll-components
• Owner: helpscout
• License: mit
• Created: 2017-05-16T23:25:16.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-08-19T20:34:59.000Z (about 5 years ago)
• Last Synced: 2024-05-13T00:21:02.290Z (6 months ago)
• Topics: components, deprecated, jekyll, open-source
• Language: Ruby
• Size: 25.4 KB
• Stars: 4
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# jekyll-components 🌟 [![Build Status](https://travis-ci.org/helpscout/jekyll-components.svg?branch=master)](https://travis-ci.org/helpscout/jekyll-components) [![Gem Version](https://badge.fury.io/rb/jekyll-components.svg)](https://badge.fury.io/rb/jekyll-components)

## DEPRECATED: Please use [jekyll-spark](https://github.com/helpscout/jekyll-spark) instead!!!

A Jekyll library for building 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-components'

```

And then execute:

```

bundle

```

Or install it yourself as:

```

gem install jekyll-components

```

## Documentation

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

## Examples

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