rehype-shift-heading

rehype plugin to change the rank (depth, level) of headings

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
rehype-shift-heading
101.0.2a year agoa year agoMinified + gzip package size for rehype-shift-heading in KB

Readme

rehype-shift-heading
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
rehype plugin to change the rank of headings.

Contents

*   [`unified().use(rehypeShiftHeading, options)`](#unifieduserehypeshiftheading-options)

What is this?

This package is a unified
(rehype) plugin to change the rank (also known as depth or level) of headings (so <h1> through <h6>). You can increase (by passing a positive number) or decrease (negative number) all headings.
unified is a project that transforms content with abstract syntax trees (ASTs). rehype adds support for HTML to unified. hast is the HTML AST that rehype uses. This is a rehype plugin that changes headings in the tree.

When should I use this?

This plugin is particularly useful when merging documents into each other. For example, when injecting a readme.md that starts with an <h1> into a site that uses an <h1> for the title of the website. This plugin can be used to shift all the headings inside the readme.
This plugin is built on hast-util-shift-headinghast-util-shift-heading, which does the work on syntax trees. rehype focusses on making it easier to transform content by abstracting such internals away.

Install

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

In Deno with Skypack:
import rehypeShiftHeading from 'https://cdn.skypack.dev/rehype-shift-heading@1?dts'

In browsers with Skypack:
<script type="module">
  import rehypeShiftHeading from 'https://cdn.skypack.dev/rehype-shift-heading@1?min'
</script>

Use

Say our module example.js looks as follows:
import {rehype} from 'rehype'
import rehypeShiftHeading from 'rehype-shift-heading'

main()

async function main() {
  const file = await rehype()
    .data('settings', {fragment: true})
    .use(rehypeShiftHeading, {shift: 1})
    .process('<h1>Alpha!</h1>')

  console.log(String(file))
}

Now, running node example yields:
<h2>Alpha!</h2>

API

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

unified().use(rehypeShiftHeading, options)

rehype plugin to change the rank (depth, level) of headings. Does not shift past h1 and h6.
options
Configuration (optional).
options.shift
Number to shift headings (number, required). Can be negative to decrease heading levels.

Types

This package is fully typed with TypeScript. It exports an Options type, which specifies the interface of the accepted options.

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 1+, rehype-stringify version 1+, rehype version 1+, and unified version 4+.

Security

Use of rehype-shift-heading is safe.

Related

— add `id`s to headings
— add links to headings

Contribute

See contributing.mdcontributing in rehypejs/.githubhealth for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor