# rehype-infer-title-meta
> rehype plugin to infer file metadata from the main title of a document
Latest version **2.0.0** (published 2023-09-02) · MIT license · 0 weekly downloads
## Install
```sh
npm install rehype-infer-title-meta
pnpm add rehype-infer-title-meta
yarn add rehype-infer-title-meta
bun add rehype-infer-title-meta
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities; high quality score.
Warnings: low downloads.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-09-02 |
| First published | 2021-09-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 4 |
| Unpacked size | 13.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Titus Wormer |
| Maintainers | wooorm, kmck |
| Keywords | file, hast, html, meta, plugin, rehype, rehype-plugin, title, unified |
## Links
- npm: https://www.npmjs.com/package/rehype-infer-title-meta
- Repository: https://github.com/rehypejs/rehype-infer-title-meta
- Homepage: https://github.com/rehypejs/rehype-infer-title-meta#readme
- Issues: https://github.com/rehypejs/rehype-infer-title-meta/issues
- Funding: https://opencollective.com/unified
- npm.io page: https://npm.io/package/rehype-infer-title-meta
## Dependencies (4)
- [vfile](https://npm.io/package/vfile.md) ^6.0.0
- [@types/hast](https://npm.io/package/@types/hast.md) ^3.0.0
- [hast-util-select](https://npm.io/package/hast-util-select.md) ^6.0.0
- [hast-util-to-text](https://npm.io/package/hast-util-to-text.md) ^4.0.0
## Alternatives
- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads
## Recent versions
- 2.0.0 (latest) — 2023-09-02
- 1.1.0 — 2022-06-12
- 1.0.1 — 2022-01-23
- 1.0.0 — 2021-09-09
## README
# rehype-infer-title-meta
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
**[rehype][]** plugin to infer the title of a document.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`unified().use(rehypeInferTitleMeta, options?)`](#unifieduserehypeinfertitlemeta-options)
* [`Options`](#options)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
## 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-document`][rehype-document] or [`rehype-meta`][rehype-meta].
When both are used together, the `` is populated with the document’s
title.
## Install
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
```sh
npm install rehype-infer-title-meta
```
In Deno with [`esm.sh`][esmsh]:
```js
import rehypeInferTitleMeta from 'https://esm.sh/rehype-infer-title-meta@2'
```
In browsers with [`esm.sh`][esmsh]:
```html
<script type="module">
import rehypeInferTitleMeta from 'https://esm.sh/rehype-infer-title-meta@2?bundle'
</script>
```
## Use
Say our module `example.js` looks as follows:
```js
import rehypeDocument from 'rehype-document'
import rehypeFormat from 'rehype-format'
import rehypeInferTitleMeta from 'rehype-infer-title-meta'
import rehypeStringify from 'rehype-stringify'
import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype'
import {unified} from 'unified'
const file = await unified()
.use(remarkParse)
.use(remarkRehype)
.use(rehypeInferTitleMeta)
.use(rehypeDocument)
.use(rehypeFormat)
.use(rehypeStringify)
.process('# Hello, world!')
console.log(file.data)
console.log(String(file))
```
…now running `node example.js` yields:
```js
{meta: {title: 'Hello, world!'}}
```
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Hello, world!
Hello, world!