Skip to content

Jekyll plugin to retrieve content from any Strapi API.

License

Notifications You must be signed in to change notification settings

orangitfi/jekyll-strapi

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

jekyll-strapi

Install

Add the "jekyll-strapi" gem to your Gemfile:

gem 'jekyll-strapi', github: 'orangitfi/jekyll-strapi'

Then add "jekyll-strapi" to your plugins in _config.yml:

plugins:
    - jekyll-strapi

Configuration

strapi:
    # Your API endpoint (optional, default to https://localhost:1337)
    endpoint: https://localhost:1337
    # Collections, key is used to access in the strapi.collections
    # template variable
    collections:
        # Example for a "articles" collection
        articles:         
            # Collection name (optional)
            type: article
            # Permalink used to generate the output files (eg. /articles/:id).
            permalink: /articles/:id/
            # Optional custom query eg. ?author.id=1 (optional)
            query: ?author.id=1
            # Layout file for this collection
            layout: strapi_article.html
            # Generate output files or not (default: false)
            output: true

Usage

This plugin provides the strapi template variable. This template provides access to the collections defined in the configuration.

Using Collections

Collections are accessed by their name in strapi.collections. The articles collections is available at strapi.collections.articles.

To list all documents of the collection:

{% for post in strapi.collections.articles %}
<article>
    <header>
        {{ post.title }}
    </header>
    <div class="body">
        {{ post.content }}
    </div>
</article>
{% endfor %}

About

Jekyll plugin to retrieve content from any Strapi API.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 100.0%