https://github.com/netlify/jekyll-gdrive

Access a Google Drive Spreadsheet from your Jekyll templates
https://github.com/netlify/jekyll-gdrive

Last synced: 3 months ago
JSON representation

Access a Google Drive Spreadsheet from your Jekyll templates

• Host: GitHub
• URL: https://github.com/netlify/jekyll-gdrive
• Owner: netlify
• License: mit
• Archived: true
• Created: 2014-12-11T23:10:08.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2020-05-26T17:58:24.000Z (over 4 years ago)
• Last Synced: 2024-05-12T11:20:32.386Z (6 months ago)
• Language: Ruby
• Size: 12.7 KB
• Stars: 116
• Watchers: 9
• Forks: 24
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Jekyll Gdrive Plugin

Access data from a Google Drive Spreadsheet in your Jekyll sites

## Installation

Add these lines to your Gemfile:

```ruby

group :jekyll_plugins do

  gem 'jekyll-gdrive'

end

```

And then execute:

    $ bundle install

## Usage

Before you can access any data from GDrive you need to configure your GDrive API credentials. After installing the plugin, run:

    $ bundle exec jekyll gdrive

And follow the instructions to create an application in Google's developer console and generate a refresh token.

Once you have the token, you need to set it up as an environment variable before running `jekyll build`. The GDrive plugin will give you an export statement you can use to setup your environment:

    $ export GDRIVE=::

You'll also need to configure the plugin to use the right spreadsheet.

Add this to your `_config.yml`:

```yaml

gdrive:

  sheet: "title of my spreadsheet"

```

## Accessing your Google Sheet data

In any Liquid template you can now use: `site.data.google_sheet` to access your sheet data.

Example:

```html

    

      {% for row in site.data.google_sheet limit:1 %}

        

          {% for col in row %}{{col}}{% endfor %}

        

      {% endfor %}

    

    

      {% for row in site.data.google_sheet offset:1 %}

        

          {% for col in row %}{{col}}{% endfor %}

        

      {% endfor %}  

    

  

```

## Caching

Google's Drive API is not incredibly fast. When working in `jekyll serve --watch` mode you'll quickly get tired of waiting for the spreadsheet data to load on every refresh.

To work around this you can specify a cache period for the gdrive plugin in the Jekyll configuration:

```yaml

gdrive:

   sheet: "My sheet"

   cache_period: 5 minutes

```

This will store the sheet in a local `_gdrive_cache` file and only reload the sheet data once every 5 minutes.

You can specify the time in `seconds`, `minutes` or `hours`.

## Contributing

1. Fork it ( https://github.com/[my-github-username]/jekyll-gdrive/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request