https://github.com/mikahanninen/grav-plugin-facebook

Facebook plugin for Grav CMS https://github.com/getgrav/grav
https://github.com/mikahanninen/grav-plugin-facebook

facebook-album facebook-plugin facebook-post feed grav grav-plugin

Last synced: 22 days ago
JSON representation

Facebook plugin for Grav CMS https://github.com/getgrav/grav

• Host: GitHub
• URL: https://github.com/mikahanninen/grav-plugin-facebook
• Owner: mikahanninen
• License: mit
• Created: 2016-10-20T18:33:51.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-03-31T20:06:47.000Z (over 5 years ago)
• Last Synced: 2024-10-04T15:25:11.789Z (about 1 month ago)
• Topics: facebook-album, facebook-plugin, facebook-post, feed, grav, grav-plugin
• Language: JavaScript
• Homepage:
• Size: 2.26 MB
• Stars: 16
• Watchers: 6
• Forks: 12
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Grav Facebook Plugin

`Facebook` is a simple [Grav][grav] Plugin that includes your Facebook page content to your Grav website. Plugin can be used to get any public Facebook page content.

### Posts example

![](assets/facebook_post_example.png)

### Events example

![](assets/facebook_events_example.png)

### Album example

![](assets/facebook_album_example.png)

# Installation

Installing the Facebook plugin can be done in one of two ways. Using GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.

## GPM Installation (Preferred)

The simplest way to install this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm) through your system's Terminal (also called the command line).  From the root of your Grav install type:

    bin/gpm install facebook

This will install the Instagram plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/facebook`.

## Manual Installation

To install this plugin, just download the zip version of this repository and unzip it under `/your/site/grav/user/plugins`. Then, rename the folder to `facebook`. You can find these files either on [GitHub](https://github.com/mikahanninen/grav-plugin-facebook) or via [GetGrav.org](http://getgrav.org/downloads/plugins#extras).

You should now have all the plugin files under

    /your/site/grav/user/plugins/facebook

# Configuration

You need to provide few configurations in order for the feed show up. In your Grav Administration panel, go to Plugins > Facebook to view the plugin configuration page.

Enter the Facebook *page_id* which feed you want to show, and your Facebook API *application_id* and *application_secret*.

For more information how to get application set up, see the [Facebook Developers documentation](https://developers.facebook.com/).

# Customization

To customize how the your feed looks like, you might want to customize the generated markup. To do that, copy the template file [facebook.html.twig](templates/partials/facebook.html.twig) to your `templates/partials` folder of your theme. For example:

```

/your/site/grav/user/themes/custom-theme/templates/partials/facebook.html.twig

```

It will now override the default markup of the feed. You can tweak it however you like.

# Config Defaults

If you need to override some plugin default values, the best practise is to copy the [facebook.yaml](facebook.yaml) file into your `users/config/plugins/` folder (create it if it doesn't exist), and then modify there. This will override the default settings.

Facebook *page_id* can be found with service like [Find your Facebook ID](http://findmyfbid.com/).

# Getting Facebook Posts

You simply need to include a function your template file such as:

```

{{ facebook_posts() }}

```

This will be converted into your Facebook posts as follows:

```



{{ sectionTitle }}

  


    

    
{{ post.time }}

    
{{ post.message }}

    {{ post.image }}

    

  

  ...



```


## Filtering by tags

You can filter Facebook posts by tags function parameter or with config parameter *Tag filter*.

```

{{ facebook_posts('#MySpecialTag') }}

```

# Getting Facebook Events

You simply need to include a function your template file such as:

```

{{ facebook_events() }}

```

This will be converted into your Facebook events as follows:

```



{{ sectionTitle }}


  

    

      {{ event.start_time.monthName }}

      {{ event.start_time.day }}

    

    

      {{ event.name }}{{ event.place }}

      {{ event.period }}

    

  

  ...



```


# Getting Facebook Album

You simply need to include a function your template file such as:

```

{{ facebook_album() }}

```

In the above 'album.name' is set at plugin configuration.

Or you can give album name as function parameter like this:

```

{{ facebook_album('My Greatest Album') }}

```

This will be converted into your Facebook album as follows:

```



Album: {{ album.name }}



    

    ...





```


## The Unitegallery jQuery plugin

[Unite gallery](http://unitegallery.net/) can be used to display album photos and its theme can be set from the plugin configuration.