micromark-core-commonmark

micromark constructs that make up the core of CommonMark. Some of these can be turned off, but they are often essential to markdown and weird things might happen.

Contents

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

What is this?

This package exposes the default constructs.

When should I use this?

This package is useful when you are making your own micromark extensions.

Install

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

npm install micromark-core-commonmark

In Deno with esm.sh:

import * as core from 'https://esm.sh/micromark-core-commonmark@1'

In browsers with esm.sh:

<script type="module">
  import * as core from 'https://esm.sh/micromark-core-commonmark@1?bundle'
</script>

Use

import {autolink} from 'micromark-core-commonmark'

console.log(autolink) // Do things with `autolink`.

API

This module exports the following identifiers: attention, autolink, blankLine, blockQuote, characterEscape, characterReference, codeFenced, codeIndented, codeText, content, definition, hardBreakEscape, headingAtx, htmlFlow, htmlText, labelEnd, labelStartImage, labelStartLink, lineEnding, list, setextUnderline, thematicBreak. There is no default export.

Each identifier refers to a construct.

See the code for more on the exported constructs.

Types

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

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, micromark-core-commonmark@2, compatible with Node.js 16. This package works with micromark@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