rehype-document

Wrap a document around the syntax tree

2.0.0
Source
npm

Version published: 8 years ago

Weekly downloads: 10K; increased by14.31%

Maintainers: 1

Weekly downloads

Created: 9 years ago

Source

rehype-document

Wrap a document around HTML with rehype.

Installation

npm:

npm install rehype-document

Usage

var unified = require('unified');
var createStream = require('unified-stream');
var parse = require('remark-parse');
var mutate = require('remark-rehype');
var stringify = require('rehype-stringify');
var document = require('rehype-document');

var processor = unified()
  .use(parse)
  .use(mutate)
  .use(document, {title: 'Hi!'})
  .use(stringify);

process.stdin
  .pipe(createStream(processor))
  .pipe(process.stdout)
  .on('error', console.error);

When the following is given on stdin(4):

## Hello world!

This is **my** document.

Yields the following on stdout(4):

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Hi!</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<h2>Hello world!</h2>
<p>This is <strong>my</strong> document.</p>
</body>
</html>

API

`rehype().use(document[, options])`

`options`

title (string, default: name of file, if any) — Text to use as title;
language (string, default: 'en') — Natural language of document (BCP 47);
responsive (boolean, default: true) — Whether to insert a meta[viewport];
doctype (string, default: '5') — Doctype to use;
css (string or Array.<string>, default: []) — Stylesheets to include in head;
js (string or Array.<string>, default: []) — Scripts to include at end of body.

License

Keywords

FAQs

What is rehype-document?

Is rehype-document popular?

Is rehype-document well maintained?

Package last updated on 23 Feb 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install