Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/strapi-community/jekyll-strapi

Jekyll plugin to retrieve content from any Strapi API.
https://github.com/strapi-community/jekyll-strapi

hacktoberfest hacktoberfest2022

Last synced: about 2 months ago
JSON representation

Jekyll plugin to retrieve content from any Strapi API.

Awesome Lists containing this project

README 

        
# jekyll-strapi-4



This plugin works with Strapi 4 and is based on [jekyll-strapi](https://github.com/strapi-community/jekyll-strapi/tree/v0.1.2) plugin for Strapi 3.



![](deer-jekyll-strapi-4.png?raw=true)



Q: Why the Deer for logo?



A: Every project deserves to have the cute deer as a logo.



## Features



* Support for Strapi 4

* Authentication

* Permalinks

* Caching and collecting assets from Strapi

* Added UnitTests

* Documentation in Jekyll format



## Install



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



```

gem "jekyll-strapi-4"

```



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



```

plugins:

    - jekyll-strapi-4

```



## Configuration



```yaml

strapi:

    # Your API endpoint (optional, default to http://localhost:1337)

    endpoint: http://localhost:1337

    # Collections, key is used to access in the strapi.collections

    # template variable

    collections:

        # Example for a "Photo" collection

        photos:

            # Collection name (optional)

            # type: photos

            # Permalink used to generate the output files (eg. /articles/:id).

            permalink: /photos/:id/

            # Permalinks defined for different locales

            permalinks:

              pl: "/zdjecia/:id"

            # Parameters (optional)

            parameters:

              sort: title:asc

              pagination[pageSize]: 10

            # Populate page (optional, default "*")

            # populate: "*"

            # Layout file for this collection

            layout: photo.html

            # Single request for collection, default false

            single_request: true

            # Generate output files or not (default: false)

            output: true

```



This works for the following collection *Photo* in Strapi:



| Name    | Type  |

| ------- | ----- |

| Title   | Text  |

| Image   | Media |

| Comment | Text  |



### Authentication



To access non Public collections (and by default all Strapi collections are non Public) you must to generate a token inside your strapi instance and set it as enviromental variable `STRAPI_TOKEN`.



It is recommended that you will use new Content API tokens for this task: https://strapi.io/blog/a-beginners-guide-to-authentication-and-authorization-in-strapi



## 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 ```_layouts/home.html```:



```

---

layout: default

---



  
Photos


  {%- if strapi.collections.photos.size > 0 -%}

  

  {%- endif -%}



```



### Attributes



All object's data you can access through ``` {{ page.document.strapi_attributes }}```. This plugin also introduces new filter asset_url which perform downloading the asset into the assets folder and provides correct url. Thanks for this you have copies of your assets locally without extra dependency on Strapi ```_layouts/photo.html```:



```

---

layout: default

---





  
{{ page.document.title }}


  
{{ page.document.strapi_attributes.Title }}


  
{{ page.document.strapi_attributes.Comment }}


  



```



### Request parameters



Define your request parameters in config files (check configuration).



If you want to add custom logic use custom_path_params method. You can use it by create _plugins/filename.rb.



```ruby

module Jekyll

  module Strapi

    class StrapiCollection

      def custom_path_params

        # ex. for multilanguage plugin you might want get request by page lang

        "&locale=#{@site.config["lang"]}"

      end

    end

  end

end

```



### Single request



When you request for a collection it makes a collection request and collection resources request. When you have a small collection like testimonials you might not make n+1 requests but only one. In that case use single_request: true in your _config file.



```yaml

strapi:

  collections:

    photos:

      single_request: true

```



You can always add to your parameters populate parameter to get additional data in your collection request.



### Permalinks



When you have a multi-language content, you might want generate a proper url based on different patterns, for example:

| Language | permalink pattern | example |

| ----------- | ----------- | - |

| en | /image/:slug |yourdomain.com/image/orange/ |

| es | /imagen/:slug | yourdomain.com/imagen/naranja/ |

| pl | /zdjecie/:slug | yourdomain.com/zdjecie/pomarancza/ |



In that case you have to

1. set locales [on request parameters](#request-parameters),

2. set permalinks patterns [on _config.yml](#configuration).



When you create permalinks, set default permalink and optionals permalinks.



```yaml

strapi:

  collections:

    photos:

      permalink: /image/:slug/

      permalinks:

        es: /imagen/:slug

        pl: /zdjecia/:slug



```