JSPM

rehype-partials

1.0.6
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 11
  • Score
    100M100P100Q47677F
  • License MIT

Partials support for rehype

Package Exports

  • rehype-partials

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (rehype-partials) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

rehype-partials

Build Status Coverage Status

Partials support for rehype.

Usage

With the following html,

index.html
<div class='container'>
  <!-- href='include/hello.html' -->
</div>
./include/hello.html
<div class='hello'>
  <!-- href='world.html' -->
</div>
./include/world.html
<div class='world'>
  <p>world</p>
</div>

and the following js,

index.js
var reporter = require('vfile-reporter')
var format = require('rehype-format')
var vfile = require('to-vfile')
var rehype = require('rehype')
var partials = require('rehype-partials')

rehype()
  .use(partials)
  .use(format)
  .process(toVfile.readSync('./index.html'), function (err, file) {
    console.error(reporter(err || file))
    console.log(String(file))
  })

will output:

./index.html: no issues found
<html>
  <head></head>
  <body>
    <div class="container">
      <div class="hello">
        <div class="world">
          <p>world</p>
        </div>
      </div>
    </div>
  </body>
</html>

Options

options.handle

Type: function

Default: fs.readFile

Function used to get a partial. example

options.cwd

Type: String

Default: ''

Set the current working directory to resolve a partial's path.

options.noresolve

Type: Boolean

Default: false

Whether or not to use path.resolve when looking for a partial.

options.messages

Type: Boolean

Default: true

Whether to include messages generated when parsing a partial.

License

MIT © Paul Zimmer