Nodeschool Public Materials

    serenity

    1.1.6 • Public • Published

    Serenity

    An easy system for generating (and local development of) static sites, using variables and templates.

    Install

    $ npm install -g serenity

    Note: may require sudo to install globally!

    Usage

    $ serenity

    Running the serenity command will immediately start watching the current directory and build the site within ./_site. It will also serve the site on localhost:4000.

    Options

    Short Long Description
    --no-server If specified, no server will be started and the process will exit after generating the site.
    -p --port Number. Specify the port for the server to use, defaults to 4000.
    -v --version Print the current version of serenity
    -a --asset_host Define an asset host (such as a CDN) for all compiled assets
    -l --live_load Generate assets on the fly as they're requested, rather than generating the entire site every time there's a change (default: false)
    -w --watch Watch the current directory for changes and regenerate (default: true)
    -c --convert Boolean. Default false. This will attempt to convert a Jekyll static site into a Serenity one. Very beta. BEWARE!

    Configuration options can also be specified in a file named serenity.js in the root of your directory. Usage and options for this can be seen in the defaults.js file

    Keywords

    none

    Install

    npm i serenity

    DownloadsWeekly Downloads

    1

    Version

    1.1.6

    License

    MIT

    Last publish

    Collaborators

    • simontabor