Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Automatically refreshes your website whenever a rengeration is performed
https://github.com/docpad/docpad-plugin-livereload

docpad-plugin

Last synced: 2 months ago
JSON representation

Automatically refreshes your website whenever a rengeration is performed

Host: GitHub
URL: https://github.com/docpad/docpad-plugin-livereload
Owner: docpad
License: other
Created: 2012-10-17T11:40:19.000Z (about 12 years ago)
Default Branch: master
Last Pushed: 2024-01-01T03:07:55.000Z (about 1 year ago)
Last Synced: 2024-04-26T18:21:23.958Z (9 months ago)
Topics: docpad-plugin
Language: CoffeeScript
Homepage:
Size: 202 KB
Stars: 11
Watchers: 16
Forks: 6
Open Issues: 9
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

# Live Reload Plugin for [DocPad](https://docpad.org)

Automatically refreshes your [DocPad](https://docpad.org) built website whenever a regeneration is performed

## Install

1. Install the Plugin

``` bash
docpad install livereload
```

1. Ensure your layout outputs the scripts block

1. In eco:

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

1. In jade:

``` 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](https://github.com/primus/primus) 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

- [Watching doesn't work, works only some of the time, or I get `EISDIR` errors](http://docpad.org/docs/troubleshoot#watching-doesn-t-work-works-only-some-of-the-time-or-i-get-eisdir-errors)