DocPad
Live Reload Plugin forAutomatically refreshes your DocPad built website whenever a regeneration is performed
Install
-
Install the Plugin
docpad install livereload
-
Ensure your layout outputs the scripts block
-
In eco:
<%- @getBlock('scripts').toHTML() %>
-
In jade:
!= getBlock('scripts').toHTML()
-
Configure
enabled
This option specifies whether or not this plugin should be enabled or disabled, by default it is true
for the development environment and false
for all other environments.
inject
This option specifies whether or not we should try to inject our socket library into the page. It is true
by default.
getSocket
This option when falsey (the default) means we will create our own socket instance, however if you already have your own socket instance you can set this option as a function that will return your own socket instance.
channel
This option specifies the which channel we should listen to, it defaults to /docpad-livereload
pathname
This option specifies the the pathname that primus should use, it defaults to /docpad-livereload
socketOptions
This option allows you to customise the primus configuration that we use if we have to create our own instance.
generateBeforeBlock
, generateAfterBlock
, listenBlock
, injectBlock
, scriptBlock
, styleBlock
These options allow you to customise the content of the scripts and styles that are injected into your page by this plugin. Check out the source code of this plugin to figure out their usage.
Troubleshooting
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:
Sponsors
No sponsors yet! Will you be the first?
Contributors
These amazing people have contributed code to this project:
- Alex Mesarosh — view contributions
- Antoine Brault
- Antoine Brault — view contributions
- Benjamin Lupton — view contributions
- Bruno Heridet — view contributions
- Garth Braithwaite — view contributions
- Rob Loach — view contributions
- Scott O'Reilly — view contributions
- Stephen Brown II — view contributions
- Vaughan Rouesnel — 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: