Package detail

docpad-plugin-services

docpad11MIT2.12.0

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

analytics, coffeescript, docpad, docpad-plugin, esnext, facebook-follow, facebook-like, ga, gaug.es, gauges, github-follow, google analytics, hacker-news-submit, mixpanel, node, quora-follow, reddit-submit, reinvigorate, shields.io, travis, travis-ci, travisci, twitter-follow, twitter-tweet, zopim

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
Gauges
Google Analytics
- NOTE: v2.5.0 of this plugin and after are for the new Google Universal Analytics API, if you have not yet upgraded, then you will want to use v2.4 of this plugin or earlier.
Inspectlet
Mixpanel
Reinvigorate
Zopim

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:

# ...
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'
# ..

If you would also like to disable a service inside the development environment, add the following as well:

# ...
environments:
    development:
        templateData:
            site:
                services:
                    serviceToDisable: false
# ...

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Benjamin Lupton — view contributions

Contributors

These amazing people have contributed code to this project:

Benjamin Lupton — view contributions
Craig Davison — view contributions
Michael Duane Mooring — view contributions
Rob Loach — view contributions
Troy Kershaw — view contributions
Zearin — view contributions
vsopvsop — view contributions

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under:

MIT License

changelog

History

v2.12.0 2020 October 29

Updated dependencies, base files, and editions using boundation

v2.11.0 2020 September 8

Updated dependencies, base files, and editions using boundation

v2.10.0 2020 September 8

Updated dependencies, base files, and editions using boundation

v2.9.0 2020 August 6

Updated dependencies, base files, and editions using boundation
Minimum required node version changed from node: >=0.12 to node: >=10 to keep up with mandatory ecosystem changes

v2.8.0 2018 July 11

Updated base files using boundation
Compiled with CoffeeScript v2
Removed unused extendr dependency

v2.7.0 2017 April 18

Updated base files
Bumped minimum node version to >=0.12 due to failed builds on earlier

v2.6.0 2014 May 17

Better reddit button that now uses the page url
Better hacker news button (new ideal width is 100px)

v2.5.0 2013 December 10

Use Google Universal Analytics instead of the now-old ga.js API

v2.4.6 2013 October 31

Use shields.io for flattr as well

v2.4.5 2013 October 31

Use shields.io for badges

v2.4.4 2013 October 5

Fixed inspectlet error for everyone not using it (regression from v2.3.0)

v2.4.3 2013 October 4

Fixed inspectlet service (regression from v2.3.0)

v2.4.2 2013 September 30

Fixed inspectlet service (regression from v2.3.0)

v2.4.1 2013 September 30

Fixed github star error (regression from v2.4.0)

v2.4.0 2013 September 30

Added buttons: - Github Star

v2.3.0 2013 September 17

Renamed social buttons to service buttons - getSocialButtons to getServiceButtons - social-button to service-button
Most of the template helpers now can have the services object swapped out by passing it as the first object
Added services: - Inspectlet
Added buttons: - Travis Status Button - Fury Button - Gittip Button - Flattr Button - Paypal Button