Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 1.59 KB

readme.md

File metadata and controls

59 lines (45 loc) · 1.59 KB
Raw

Install

Add this file to _plugins in the root of your Jekyll site.

Configure

This plugin reads settings from the _config.yml file. Add settings as attributes or an array of attributes for multiple files.

Example

jekyll_get:
  data: team
  json: 'https://18f.gsa.gov/hub/api/team/'

Or

jekyll_get:
  - data: team
    json: 'https://18f.gsa.gov/hub/api/team/'
  - data: projects
    json: 'https://18f.gsa.gov/hub/api/projects/'

Use in a liquid template as if it were a local data file:

{% for member in site.data.team %}
  Hello {{member[1].first_name}}
{% endfor %}

Optionally, set a cache attribute to save a local copy of the data in the _data directory:

jekyll_get:
  - data: team
    json: 'https://18f.gsa.gov/hub/api/team/'
    cache: true
  - data: projects
    json: 'https://18f.gsa.gov/hub/api/projects/'
    cache: true
  - data: pif_team
    json: 'https://18f.gsa.gov/hub/api/pif_team/'
    cache: true
  - data: pif_projects
    json: 'https://18f.gsa.gov/hub/api/pif_projects/'
    cache: true

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.