unified

Project: remarkjs/remark-normalize-headings

Package: remark-normalize-headings@3.0.1

  1. Dependents: 0
  2. remark plugin to make sure there is a single top level heading in a document by adjusting heading ranks accordingly
  1. remark 199
  2. unified 181
  3. markdown 145
  4. plugin 138
  5. mdast 86
  6. remark-plugin 70
  7. heading 25
  8. depth 5
  9. level 5
  10. title 4
  11. count 4
  12. header 2

remark-normalize-headings

Build Coverage Downloads Size Sponsors Backers Chat

remark plugin to make sure there is a single top level heading in a document by adjusting heading ranks accordingly.

Contents

What is this?

This package is a unified (remark) plugin to ensure there is one top level heading in a document.

unified is a project that transforms content with abstract syntax trees (ASTs). remark adds support for markdown to unified. mdast is the markdown AST that remark uses. This is a remark plugin that transforms mdast.

When should I use this?

This project is useful if you’re dealing with user generated content and want to ensure that there is a single primary heading (usually the title of the document) which everything else falls under.

Install

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

npm install remark-normalize-headings

In Deno with esm.sh:

import remarkNormalizeHeadings from 'https://esm.sh/remark-normalize-headings@3'

In browsers with esm.sh:

<script type="module">
  import remarkNormalizeHeadings from 'https://esm.sh/remark-normalize-headings@3?bundle'
</script>

Use

Say we have the following file example.md:

# Title

# Description

## Usage

### Example

## API

# Related

And our module example.js looks as follows:

import {read} from 'to-vfile'
import {remark} from 'remark'
import remarkNormalizeHeadings from 'remark-normalize-headings'

main()

async function main() {
  const file = await remark()
    .use(remarkNormalizeHeadings)
    .process(await read('example.md'))

  console.log(String(file))
}

Now, running node example yields:

# Title

## Description

### Usage

#### Example

### API

## Related

API

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

unified().use(remarkNormalizeHeadings)

Plugin to make sure there is a single top level heading in a document by adjusting heading ranks accordingly. There are no options.

Types

This package is fully typed with TypeScript. There are no extra exported types.

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 unified version 2+ and remark version 3+.

Security

Use of remark-normalize-headings does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.

Contribute

See contributing.md in remarkjs/.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 © Eugene Sharygin