nanocrane
v0.2.1
Published
versatile static-site builder library for choo
Downloads
4
Readme
nanocrane
Versatile static-site builder library for Choo.
Merges an exported Choo application + a state object with content + an HTML string and outputs a set of static HTML files.
Installation
npm i nanocraneExample
var app = require('./index.js')
var nanocrane = require('nanocrane')
var content = {
'/': { title: 'home' },
'/about': { title: 'about' }
}
var template = `
<html>
<head>
<title><!-- @title --></title>
<!-- @state -->
</head>
<!-- @content -->
</html>
`
nanocrane(app, { content: content }, template)Usage
nanocrane(app, state, htmlString, options)
app is a mounted Choo application, state is an object that'll be forwarded to Choo's state, htmlString is the template of the outputted HTML files. Returns a Promise.
state.content must be set and follow nanocontent's basic structure.
In the template it'll replace the following:
<!-- @content -->― with the HTML output of the app<!-- @state -->― with a script element that sets the initial state for Choo<!-- @title -->― with the title of the current page
Options:
{
clear: bool - whether to clear output path (default: true),
copy: array - paths to copy to output,
output: string,
outputRoute: function - called on every route with `(route, html, options)` (default: write to output directory),
verbose: bool
}