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

https://github.com/bolt/bolt-extension-github

GitHub API extension for Bolt CMS
https://github.com/bolt/bolt-extension-github

bolt-extension

Last synced: 3 months ago
JSON representation

GitHub API extension for Bolt CMS

Awesome Lists containing this project

README

        

GitHub API for Bolt
===================

Implementation of the GitHub API as a Bolt extension.

Set up
------

Set the following parameters (at a minimum) in the `app/config/extensions/github.bolt.yml` file:

```yaml
github:
org: bolt
repo: bolt
```

Template Use
------------

The following functions are available for inclusion in templates:

```
{{ github_collaborators() }}
{{ github_contributors() }}
{{ github_user(user) }}
{{ github_user_events(user) }}
```

Both `github_collaborators` and `github_contributors` take an optional Boolean where true will lookup
additional information about the members.

**Note** these lookups affect your GitHub API rate limit quite severly, especially if caching is not enabled!