rehype-extract-meta

2.0.5 • Public • Published

rehype-extract-meta

Build Coverage 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)

Running the above code with a valid htmlString will return a VFile containing the extracted contents in its data property.

VFile {
  data: {
    meta: {
      lang: '...',
      url: '...',
      title: '...',
      date: '...',
      author: '...',
      publisher: '...',
      description: '...',
      image: '...',
      keywords: ['...'],
      copyright: '...',
    }
  },
  messages: [],
  history: [],
  cwd: '...',
  value: '...'
}

API

This package exports a single plugin function.

unified().use(rehypeExtractMeta)

Rehype plugin to extract meta data from an HTML document.

License

MIT © Goran Spasojevic

Install

npm i rehype-extract-meta

DownloadsWeekly Downloads

85

Version

2.0.5

License

MIT

Unpacked Size

7.88 kB

Total Files

6

Last publish

Collaborators

  • gorango