Contents

# Jekyll ical tag

Author: Ricky Chilcott https://www.rakefire.io

Description: Pull ICS feed and provide a for-like loop of calendar events

## Installation

To your Gemfile:

`gem 'jekyll-ical-tag'`

To your `_config.yml`

```yml
plugins:
  - jekyll-ical-tag
```

## Syntax

```html
  {% ical url: https://space.floern.com/launch.ics reverse: true only_future: true %}
    {{ event.summary }}
    {{ event.description }}
    {{ event.simple_html_description }}
    {{ event.start_time }}
    {{ event.end_time }}
    {{ event.url }}
    {{ event.attendees }}
  {% endical %}
```

## Options

- `reverse` - Defaults to 'false', ordering events by start_time (or reverse start_time).
- `only_past` - Defaults to 'false', limits returned events to start_times before now.
- `only_future` - Defaults to 'false', limits returned events to start_time after now.

- `before_date` - limits returned events to dates before a specific date. This gets parsed with Ruby's Time.parse (e.g. 01-01-2018)
- `after_date` - limits returned events to dates before a specific date. This gets parsed with Ruby's Time.parse (e.g. 01-01-2018).
- `limit` - limits the number of returned events to the first N events matching the specified criteria. For example, `{% ical url: https://example.com/events.ics only_future:true limit:5 %}` returns the first five future events.

## Event Attributes:

All RFC 5545 properties are supported, examples:

- `dtstart` - start time of event
- `dtend` - end time of event
- `summary` - Title or name of event
- `description` - Notes/description of event
- `location` - Location of event
- `url` - url of event, if provided, if not, take the first url from the description.

A few helper properties are also supported:

- `attendees` - [Array] of attendees names/emails
- `simple_html_description` - Notes/description of event with urls auto-linked
- `start_time` - start time of event
- `end_time` - end time of event

# Special Thanks

Special thanks to the following contributors: @marchehab98 @meitar

Version data entries

15 entries across 14 versions & 1 rubygems

Version	Path
jekyll-ical-tag-1.5.1	README.md
jekyll-ical-tag-1.5	README.md
jekyll-ical-tag-1.4.0	README.md
jekyll-ical-tag-1.4.0	_site/README.md
jekyll-ical-tag-1.3.3	README.md
jekyll-ical-tag-1.3.2	README.md
jekyll-ical-tag-1.3.1	README.md
jekyll-ical-tag-1.3	README.md
jekyll-ical-tag-1.2.5	README.md
jekyll-ical-tag-1.2.4	README.md
jekyll-ical-tag-1.2.3	README.md
jekyll-ical-tag-1.2.2	README.md
jekyll-ical-tag-1.2.1	README.md
jekyll-ical-tag-1.2.0	README.md
jekyll-ical-tag-1.1.0	README.md