Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://github.com/syntax-tree/mdast-normalize-headings below:

syntax-tree/mdast-normalize-headings: utility to make sure there is no more than a single top-level heading in the document

mdast utility to normalize heading depths.

• What is this?
• When should I use this?
• Install
• Use
• API
  • normalizeHeadings(tree)
• Types
• Compatibility
• Security
• Related
• Contribute
• License

This package is a utility that normalizes the heading structure of documents. It makes sure one top-level heading is used by adjusting headings depths accordingly.

This utility can be useful when working with tools that assume that there is a single top-level heading that contains some meta-information (usually a title) about the document.

A plugin, remark-normalize-headings, exists that does the same but for remark.

This package is ESM only. In Node.js (version 16+), install with npm:

npm install mdast-util-normalize-headings

In Deno with esm.sh:

import {normalizeHeadings} from 'https://esm.sh/mdast-util-normalize-headings@4'

In browsers with esm.sh:

<script type="module">
  import {normalizeHeadings} from 'https://esm.sh/mdast-util-normalize-headings@4?bundle'
</script>

import {normalizeHeadings} from 'mdast-normalize-headings'
import {u} from 'unist-builder'

const tree = u('root', [
  u('heading', {depth: 1}, [u('text', 'title')]),
  u('heading', {depth: 2}, [u('text', 'description')]),
  u('heading', {depth: 1}, [u('text', 'example')])
])

normalizeHeadings(tree)

console.log(tree)

Yields:

{
  type: 'root',
  children: [
    {type: 'heading', depth: 1, children: [Array]},
    {type: 'heading', depth: 3, children: [Array]},
    {type: 'heading', depth: 2, children: [Array]}
  ]
}

This package exports the identifier normalizeHeadings. There is no default export.

Make sure that there is only one top-level heading in the document by adjusting headings depths accordingly.

• tree (Node) — tree to change

Nothing (undefined).

This package is fully typed with TypeScript. It exports no additional types.

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, mdast-normalize-headings@^4, compatible with Node.js 16.

Use of mdast-normalize-headings does not involve hast so there are no openings for cross-site scripting (XSS) attacks.

• remark-normalize-headings — remark plugin

See contributing.md in syntax-tree/.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.

MIT © Eugene Sharygin

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4