Skip to content

Latest commit

 

History

History
87 lines (56 loc) · 1.54 KB

readme.md

File metadata and controls

87 lines (56 loc) · 1.54 KB
Raw

Built-in Transforms

var stakit = require('stakit')
var transforms = stakit.transforms
// or
var { lang, meta } = require('stakit/transforms')

Stakit includes the following built-in transforms:

lang

transform(lang, str)

Sets the language property of the <html> element to str.

meta

transform(meta, obj)

Appends <meta> tags to the <head>.

collect

transform(collect, fn(ctx, html))

Collects the complete HTML from the stream and passes it to fn along with the full context. Put it as the last transform, in order to have the correct HTML.

includeScript

transform(includeScipt, src)

Appends a <script> tag to the <body> with the passed src.

includeStyle

transform(includeStyle, href)

Appends a <link rel="stylesheet"> tag to the <head> with the passed href.

prependToHead

transform(prependToHead, str)

Prepends str to the <head>.

appendToHead

transform(appendToHead, str)

Appends str to the <head>.

prependToBody

transform(prependToBody, str)

Prepends str to the <body>.

appendToBody

transform(appendToBody, str)

Appends str to the <body>.

Example

var { meta, collect, prependToHead } = require('stakit/transforms')

stakit()
  .transform(prependToHead, `<link rel="stylesheet" src="/style.css">`)
  .transform(meta, {
    'og:title': 'Site'
  })
  .transform(collect, function (ctx, html) {
    console.log(`Built ${ctx.route}:`)
    console.log(html, '\n')
  })