mdast-util-heading-style

mdast-util-heading-style

Get the style of an MDAST heading.

Installation

npm:

npm install mdast-util-heading-style

mdast-util-heading-style is also available as an AMD, CommonJS, and globals module, uncompressed and compressed.

Usage

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

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

style(remark.parse('### ATX').children[0]); // null
style(remark.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.

Marker

A comment marker.

Properties

• name (string) — Name of marker;
• attributes (string) — Value after name;
• parameters (Object) — Parsed attributes, tries to convert values to numbers and booleans when possible;
• node (Node) — Reference to given node.

License

MIT © Titus Wormer