/** * Transform mdast to hast. * * ##### Notes * * ###### HTML * * Raw HTML is available in mdast as `html` nodes and can be embedded in hast * as semistandard `raw` nodes. * Most utilities ignore `raw` nodes but two notable ones don’t: * * * `hast-util-to-html` also has an option `allowDangerousHtml` which will * output the raw HTML. * This is typically discouraged as noted by the option name but is useful * if you completely trust authors * * `hast-util-raw` can handle the raw embedded HTML strings by parsing them * into standard hast nodes (`element`, `text`, etc). * This is a heavy task as it needs a full HTML parser, but it is the only * way to support untrusted content * * ###### Footnotes * * Many options supported here relate to footnotes. * Footnotes are not specified by CommonMark, which we follow by default. * They are supported by GitHub, so footnotes can be enabled in markdown with * `mdast-util-gfm`. * * The options `footnoteBackLabel` and `footnoteLabel` define natural language * that explains footnotes, which is hidden for sighted users but shown to * assistive technology. * When your page is not in English, you must define translated values. * * Back references use ARIA attributes, but the section label itself uses a * heading that is hidden with an `sr-only` class. * To show it to sighted users, define different attributes in * `footnoteLabelProperties`. * * ###### Clobbering * * Footnotes introduces a problem, as it links footnote calls to footnote * definitions on the page through `id` attributes generated from user content, * which results in DOM clobbering. * * DOM clobbering is this: * * ```html *
* * ``` * * Elements by their ID are made available by browsers on the `window` object, * which is a security risk. * Using a prefix solves this problem. * * More information on how to handle clobbering and the prefix is explained in * Example: headings (DOM clobbering) in `rehype-sanitize`. * * ###### Unknown nodes * * Unknown nodes are nodes with a type that isn’t in `handlers` or `passThrough`. * The default behavior for unknown nodes is: * * * when the node has a `value` (and doesn’t have `data.hName`, * `data.hProperties`, or `data.hChildren`, see later), create a hast `text` * node * * otherwise, create a `