Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    metalsmith-browser-syncpublic

    metalsmith-browser-sync

    A Metalsmith plugin to make your workflow easier (using BrowserSync).

    Build Status

    Installation

    $ npm install metalsmith-browser-sync
    

    Example

    Pass options to the BrowserSync plugin and pass it to Metalsmith with the use method:

    var browserSync = require('metalsmith-browser-sync');
     
    metalsmith.use(browserSync({
                        server : "myBuildDirectory",
                        files  : ["src/**/*.md", "templates/**/*.hbs"]
                  }));

    The default options are:

    var defaultOpts = {
        server     : "build",
        files      : ["src/**/*.md", "templates/**/*.hbs"]
    }

    Note: you can pass any options you could normally pass to BrowserSync

    Callback

    You can also pass a callback function, which is called when BrowserSync has completed all setup tasks and is ready to use. This is useful when you need to wait for information (for example: urls, port etc) or perform other tasks synchronously.

    var browserSync = require('metalsmith-browser-sync');
     
    metalsmith.use(browserSync({
                        server : "myBuildDirectory",
                        files  : ["src/**/*.md", "templates/**/*.hbs"]
                  }, function (err, bs) {
                      // do some stuff here
                  }));

    License

    MIT - view the full license here

    install

    npm i metalsmith-browser-sync

    Downloadsweekly downloads

    257

    version

    1.1.1

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar