rehype-infer-title-meta

rehype plugin to infer file metadata from the main title of a document

Usage no npm install needed!

<script type="module">
  import rehypeInferTitleMeta from 'https://cdn.skypack.dev/rehype-infer-title-meta';
</script>

README

rehype-infer-title-meta

Build Coverage Downloads Size Sponsors Backers Chat

rehype plugin to infer the title of a document.

Contents

What is this?

This package is a unified (rehype) plugin to infer the title of a document.

unified is a project that transforms content with abstract syntax trees (ASTs). rehype adds support for HTML to unified. vfile is the virtual file interface used in unified. hast is the HTML AST that rehype uses. This is a rehype plugin that inspects hast and adds metadata to vfiles.

When should I use this?

This plugin is particularly useful in combination with rehype-meta. When both are used together, the <title> is populated with the document’s title.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install rehype-infer-title-meta

In Deno with Skypack:

import rehypeInferReadingTimeMeta from 'https://cdn.skypack.dev/rehype-infer-title-meta@1?dts'

In browsers with Skypack:

<script type="module">
  import rehypeInferReadingTimeMeta from 'https://cdn.skypack.dev/rehype-infer-title-meta@1?min'
</script>

Use

Say our module example.js looks as follows:

import {unified} from 'unified'
import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype'
import rehypeInferTitleMeta from 'rehype-infer-title-meta'
import rehypeDocument from 'rehype-document'
import rehypeMeta from 'rehype-meta'
import rehypeFormat from 'rehype-format'
import rehypeStringify from 'rehype-stringify'

main()

async function main() {
  const file = await unified()
    .use(remarkParse)
    .use(remarkRehype)
    .use(rehypeDocument)
    .use(rehypeInferTitleMeta)
    .use(rehypeMeta)
    .use(rehypeFormat)
    .use(rehypeStringify)
    .process('# Hello, world!')

  console.log(file.data)
  console.log(String(file))
}

Now running node example.js yields:

{meta: {title: 'Hello, world!'}}

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Hello, world!</title>
  </head>
  <body>
    <h1>Hello, world!</h1>
  </body>
</html>

API

This package exports no identifiers. The default export is rehypeInferTitleMeta.

unified().use(rehypeInferTitleMeta, options?)

Infer the title from a document as file metadata. The result is stored on file.data.meta.title.

options

Configuration (optional).

options.selector

CSS selector to the title (string, default: 'h1'). Can be a selector list ('title, h1, .main-heading'), in which case the first element in the tree that matches is used.

Types

This package is fully typed with TypeScript. The extra type Options is exported.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

This plugin works with rehype-parse version 3+, rehype-stringify version 3+, rehype version 4+, and unified version 6+.

Security

Use of rehype-infer-title-meta is safe.

Related

Contribute

See contributing.md in rehypejs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer