README.md

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

Sponsors

No sponsors yet! Will you be the first?

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:

• Copyright © 2012+ Bevry Pty Ltd

and licensed under:

• MIT License