4.0.0 • Published 2 years ago
rehype-extract-meta v4.0.0
rehype-extract-meta
Rehype plugin to extract meta data from an HTML document.
Install
npm install rehype-extract-metaUse
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
lang(string) - Language stringdate(string) - Document datetitle(string) - Document titledescription(string) - Document descriptionkeywords(string[]) - Document keywordsauthor(string) - Document authorpublisher(string) - Document publishercopyright(string) - Document copyrightpageUrl(string) - Page URLimageUrl(string) - Image URLfeedUrl(string) - Feed URL
Types
This package is fully typed with TypeScript.
It exports the additional type Meta.
Rehype plugin to extract meta data from an HTML document.