HckApm/node_modules/micromark-util-html-tag-name

micromark-util-html-tag-name

micromark utility with list of html tag names.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • htmlBlockNames
  • htmlRawNames
• Types
• Compatibility
• Security
• Contribute
• License

What is this?

This package exposes a list of known tag names to markdown.

When should I use this?

This package is only useful if you want to build an alternative to micromark.

Install

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

npm install micromark-util-html-tag-name

In Deno with esm.sh:

import {htmlBlockNames, htmlRawNames} from 'https://esm.sh/micromark-util-html-tag-name@1'

In browsers with esm.sh:

<script type="module">
  import {htmlBlockNames, htmlRawNames} from 'https://esm.sh/micromark-util-html-tag-name@1?bundle'
</script>

Use

import {htmlBlockNames, htmlRawNames} from 'micromark-util-html-tag-name'

console.log(htmlBlockNames) // ['address', 'article', …]
console.log(htmlRawNames) // ['pre', 'script', …]

API

This module exports the identifiers htmlBlockNames and htmlRawNames. There is no default export.

htmlBlockNames

List of lowercase HTML “block” tag names (Array<string>).

The list, when parsing HTML (flow), results in more relaxed rules (condition 6). Because they are known blocks, the HTML-like syntax doesn’t have to be strictly parsed. For tag names not in this list, a more strict algorithm (condition 7) is used to detect whether the HTML-like syntax is seen as HTML (flow) or not.

This is copied from: https://spec.commonmark.org/0.30/#html-blocks.

👉 Note: search was added in CommonMark@0.31.

htmlRawNames

List of lowercase HTML “raw” tag names (Array<string>).

The list, when parsing HTML (flow), results in HTML that can include lines without exiting, until a closing tag also in this list is found (condition 1).

This module is copied from: https://spec.commonmark.org/0.30/#html-blocks.

👉 Note: textarea was added in CommonMark@0.30.

Types

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

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 16+. Our projects sometimes work with older versions, but this is not guaranteed.

This package works with micromark version 3+.

Security

This package is safe. See security.md in micromark/.github for how to submit a security report.

Contribute

See contributing.md in micromark/.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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer