Package Exports

mdast-util-heading-style

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mdast-util-heading-style) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

mdast-util-heading-style

mdast utility to get the style of a heading.

Install

npm:

npm install mdast-util-heading-style

Use

var style = require('mdast-util-heading-style')
var unified = require('unified')
var parse = require('remark-parse')

var processor = unified().use(parse)

style(processor.parse('# ATX').children[0]) // => 'atx'
style(processor.parse('# ATX #\n').children[0]) // => 'atx-closed'
style(processor.parse('ATX\n===').children[0]) // => 'setext'

style(processor.parse('### ATX').children[0]) // => null
style(processor.parse('### ATX').children[0], 'setext') // => 'setext'

API

`style(node[, relative])`

Get the heading style of a node.

Parameters

node (Node) — Node to parse
relative (string, optional) — Style to use for ambiguous headings (atx-headings with a level of three or more could also be setext)

Returns

string ('atx', 'atx-closed', or 'setext') — When an ambiguous heading is found, either relative or null is returned.

Security

Use of mdast-util-heading-style does not involve hast so 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.