https://github.com/hexojs/hexo-browsersync

BrowserSync plugin for Hexo.
https://github.com/hexojs/hexo-browsersync

hexo hexo-plugin

Last synced: about 2 months ago
JSON representation

BrowserSync plugin for Hexo.

• Host: GitHub
• URL: https://github.com/hexojs/hexo-browsersync
• Owner: hexojs
• License: mit
• Created: 2015-01-31T12:56:50.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-06-28T19:45:08.000Z (6 months ago)
• Last Synced: 2024-10-28T16:11:57.750Z (2 months ago)
• Topics: hexo, hexo-plugin
• Language: JavaScript
• Homepage:
• Size: 69.3 KB
• Stars: 143
• Watchers: 12
• Forks: 18
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hexo-browsersync

[![NPM version](https://badge.fury.io/js/hexo-browsersync.svg)](https://www.npmjs.com/package/hexo-browsersync)

[![Coverage Status](https://coveralls.io/repos/github/hexojs/hexo-browsersync/badge.svg?branch=master)](https://coveralls.io/github/hexojs/hexo-browsersync?branch=master)

[BrowserSync] plugin for [Hexo].

## Installation

``` bash

$ npm install hexo-browsersync --save

```

## Usage

`hexo-browsersync` is transparent. Once installed, just run `hexo-server` as you usually do, and you will benefit from the features from browsersync.

## Options

BrowserSync options are supported inside `_config.yml` file, e.g.:

````yaml

browsersync:

  logLevel: "warn"

  ghostMode:

    scroll: true

  instanceName: "uniqueString"

````

You can check [BrowserSync options](https://www.browsersync.io/docs/options/) for more info. 

N.B.: `logSnippet` is disabled by default. Also, `instanceName` allows you to [create a named instance](https://www.browsersync.io/docs/api#api-create). The default value is `undefined` (anonymous instance).

## License

MIT

[BrowserSync]: https://www.browsersync.io/

[Hexo]: https://hexo.io/