docpad-plugin-services

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

npm install docpad-plugin-services
3 downloads in the last day
21 downloads in the last week
550 downloads in the last month

Services Plugin for DocPad

Build Status NPM version Gittip donate button Flattr donate button PayPayl donate button

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

Supports

These 3rd party services:

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: 'bevry/docpad'
            quoraFollowButton: 'Benjamin-Lupton'
            travisStatusButton: 'bevry/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 change 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:

Sponsors

No sponsors yet! Will you be the first?

Gittip donate button Flattr donate button PayPayl donate button

Contributors

These amazing people have contributed code to this project:

Become a contributor!

License

Licensed under the incredibly permissive MIT license

Copyright © 2012+ Bevry Pty Ltd us@bevry.me (http://bevry.me)

npm loves you