unified

Project: gorango/rehype-extract-meta

Package: rehype-extract-meta@2.0.4

  1. Rehype plugin to extract meta data from an HTML document
  1. 65%
  2. MIT
  3. 3
  1. 15 kB
  2. 699
  1. unist 132
  2. html 124
  3. rehype 91
  4. hast 75
  5. meta 10
  6. nlp 6
  7. extract 3

rehype-extract-meta

Build Coverage Types Size

Rehype plugin to extract meta data from an HTML document.

Install

npm install rehype-extract-meta

Use

import { unified } from 'unified'
import rehypeParse from 'rehype-parse'
import rehypeStringify from 'rehype-stringify'
import rehypeExtractMeta from 'rehype-extract-meta'

const processor = unified()
  .use(rehypeParse)
  .use(rehypeExtractMeta)
  .use(rehypeStringify)

const htmlString = `<html>...</html>`
const vfile = processor.processSync(htmlString)
console.log(vfile.data.meta)

Running the above code with a valid htmlString will return a VFile containing the extracted contents in its data.meta property, conforming to the type Meta.

API

This package exports a single plugin function.

unified().use(rehypeExtractMeta)

Extract meta data from HTML.

Returns

Transform (Transformer).

Meta

Data property (TypeScript type).

Fields

Types

This package is fully typed with TypeScript. It exports the additional type Meta.

Rehype plugin to extract meta data from an HTML document.

License

MIT © Goran Spasojevic