unified

Project: syntax-tree/hast-util-heading-rank

Package: hast-util-heading-rank@1.0.1

  1. Dependencies: 0·Dependents: 0
  2. hast utility to get the rank (or depth, level) of headings
  1. util 118
  2. utility 114
  3. unist 110
  4. html 110
  5. hast 60
  6. hast-util 40
  7. heading 26
  8. depth 5
  9. level 5
  10. rank 2

hast-util-heading-rank

Build Coverage Downloads Size Sponsors Backers Chat

hast utility to get the rank (or depth, level) of headings.

Install

npm:

npm install hast-util-heading-rank

Use

var h = require('hastscript')
var rank = require('hast-util-heading-rank')

rank(h('p', 'Alpha')) //=> null
rank(h('h5', 'Alpha')) //=> 5

API

headingRank(node)

Get the rank (1 to 6) of headings (h1 to h6).

Parameters
Returns

rank (number?) — Rank of the heading, or null if not a heading.

Security

hast-util-heading-rank does not mutate. There are no openings for cross-site scripting (XSS) attacks.

Contribute

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.

License

MIT © Titus Wormer