https://github.com/docpad/docpad-plugin-services

Adds super simple support for many 3rd party services to DocPad.
https://github.com/docpad/docpad-plugin-services

docpad-plugin

Last synced: 2 months ago
JSON representation

Adds super simple support for many 3rd party services to DocPad.

Host: GitHub
URL: https://github.com/docpad/docpad-plugin-services
Owner: docpad
License: other
Created: 2012-12-29T09:37:51.000Z (over 13 years ago)
Default Branch: master
Last Pushed: 2023-12-31T06:52:08.000Z (over 2 years ago)
Last Synced: 2026-01-02T07:20:51.855Z (6 months ago)
Topics: docpad-plugin
Language: CoffeeScript
Homepage:
Size: 231 KB
Stars: 18
Watchers: 12
Forks: 7
Open Issues: 17
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

Services Plugin for DocPad

Adds super simple support to DocPad for many 3rd party services, buttons and badges.

## Supports

These 3rd party services:

- [Disqus](http://disqus.com/)
- [Gauges](http://gaug.es/)
- [Google Analytics](http://www.google.com.au/analytics/)
- NOTE: v2.5.0 of this plugin and after are for the new [Google Universal Analytics API](https://developers.google.com/analytics/devguides/collection/upgrade/), if you have not yet upgraded, then you will want to use v2.4 of this plugin or earlier.
- [Inspectlet](http://www.inspectlet.com/)
- [Mixpanel](https://mixpanel.com/)
- [Reinvigorate](https://www.reinvigorate.net/)
- [Zopim](http://zopim.com/)

These social buttons:

- Google Plus One
- Reddit Submit
- Hacker News Submit
- Facebook Like
- Facebook Follow
- Twitter Tweet
- Twitter Follow
- Github Follow
- Github Star
- Quora Follow

These service badges:

- Travis CI
- Fury.io
- Gittip
- Flattr
- Paypal

## Install

### Install the Plugin

```
docpad install services
```

### Add the Script Block for most services

Ensure your layout includes the scripts block. With eco, it will look something like this:

```
<%- @getBlock('scripts').toHTML() %>
```

This is used for the Gauges, Google Analytics, Mixpanel, Reinvigorate, and Zopim services.

### Add Template Helpers for special services

- Disqus: `<%- @getDisqus() %>`
- Service Buttons: `<%- @getServiceButtons() %>`

## Configure

Add the following to your [docpad configuration file](http://docpad.org/docs/config/):

``` coffee
# ...
templateData:
site:
url: 'http://my-production-website.com'
services:
buttons: ['FacebookLike'] # used to customise the order of the buttons

facebookLikeButton:
applicationId: '266367676718271'
facebookFollowButton:
applicationId: '266367676718271'
username: 'balupton'
twitterTweetButton: 'balupton'
twitterFollowButton: 'balupton'
githubFollowButton: 'balupton'
githubStarButton: 'docpad/docpad'
quoraFollowButton: 'Benjamin-Lupton'
travisStatusButton: 'docpad/docpad'
furyButton: 'docpad'
gittipButton: 'docpad'
flattrButton: '344188/balupton-on-Flattr'
paypalButton: 'QB8GQPZAH84N6' # paypal button email id

disqus: 'disqus-id'
gauges: 'gauges-id'
googleAnalytics: 'googleAnalytics-id'
inspectlet: 'inspectlet-id'
mixpanel: 'mixpanel-id'
reinvigorate: 'reinvigorate-id'
zopim: 'zopim-id'
# ..
```