# micromark-core-commonmark

> The CommonMark markdown constructs

Latest version **2.0.3** (published 2025-02-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install micromark-core-commonmark
pnpm add micromark-core-commonmark
yarn add micromark-core-commonmark
bun add micromark-core-commonmark
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 2.0.3 |
| Published | 2025-02-27 |
| First published | 2021-06-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 16 |
| Unpacked size | 260.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2221 |
| Author | Titus Wormer |
| Maintainers | wooorm |
| Keywords | micromark, core, commonmark |

## Links

- npm: https://www.npmjs.com/package/micromark-core-commonmark
- Repository: https://github.com/micromark/micromark.git#main
- Homepage: https://github.com/micromark/micromark/tree/main#readme
- Issues: https://github.com/micromark/micromark/issues
- Funding: https://github.com/sponsors/unifiedjs
- npm.io page: https://npm.io/package/micromark-core-commonmark

## Dependencies (16)

- [devlop](https://npm.io/package/devlop.md) ^1.0.0
- [micromark-util-types](https://npm.io/package/micromark-util-types.md) ^2.0.0
- [micromark-util-symbol](https://npm.io/package/micromark-util-symbol.md) ^2.0.0
- [micromark-util-chunked](https://npm.io/package/micromark-util-chunked.md) ^2.0.0
- [micromark-factory-label](https://npm.io/package/micromark-factory-label.md) ^2.0.0
- [micromark-factory-space](https://npm.io/package/micromark-factory-space.md) ^2.0.0
- [micromark-factory-title](https://npm.io/package/micromark-factory-title.md) ^2.0.0
- [micromark-util-character](https://npm.io/package/micromark-util-character.md) ^2.0.0
- [micromark-util-resolve-all](https://npm.io/package/micromark-util-resolve-all.md) ^2.0.0
- [micromark-util-subtokenize](https://npm.io/package/micromark-util-subtokenize.md) ^2.0.0
- [micromark-factory-whitespace](https://npm.io/package/micromark-factory-whitespace.md) ^2.0.0
- [micromark-util-html-tag-name](https://npm.io/package/micromark-util-html-tag-name.md) ^2.0.0
- [micromark-factory-destination](https://npm.io/package/micromark-factory-destination.md) ^2.0.0
- [decode-named-character-reference](https://npm.io/package/decode-named-character-reference.md) ^1.0.0
- [micromark-util-classify-character](https://npm.io/package/micromark-util-classify-character.md) ^2.0.0
- [micromark-util-normalize-identifier](https://npm.io/package/micromark-util-normalize-identifier.md) ^2.0.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 2.0.3 (latest) — 2025-02-27
- 1.0.0-beta.1 (next) — 2021-06-20
- 2.0.2 — 2024-11-12
- 2.0.1 — 2024-04-23
- 2.0.0 — 2023-06-21
- 1.1.0 — 2023-05-30
- 1.0.6 — 2021-12-04
- 1.0.5 — 2021-11-22
- 1.0.4 — 2021-10-18
- 1.0.3 — 2021-10-09
- 1.0.2 — 2021-10-02
- 1.0.1 — 2021-08-21
- 1.0.0 — 2021-06-22
- 1.0.0-alpha.3 — 2021-06-16
- 1.0.0-alpha.2 — 2021-06-07
- … 1 more at https://npm.io/package/micromark-core-commonmark/versions

## README

# micromark-core-commonmark

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][bundle-size-badge]][bundle-size]
[![Sponsors][sponsors-badge]][opencollective]
[![Backers][backers-badge]][opencollective]
[![Chat][chat-badge]][chat]

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

## Contents

* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [License](#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][esm].
In Node.js (version 16+), install with [npm][]:

```sh
npm install micromark-core-commonmark
```

In Deno with [`esm.sh`][esmsh]:

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

In browsers with [`esm.sh`][esmsh]:

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

## Use

```js
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`][securitymd] in [`micromark/.github`][health] for how to
submit a security report.

## Contribute

See [`contributing.md`][contributing] in [`micromark/.github`][health] for ways
to get started.
See [`support.md`][support] for ways to get help.

This project has a [code of conduct][coc].
By interacting with this repository, organisation, or community you agree to
abide by its terms.

## License

[MIT][license] © [Titus Wormer][author]

<!-- Definitions -->

[author]: https://wooorm.com

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[build]: https://github.com/micromark/micromark/actions

[build-badge]: https://github.com/micromark/micromark/workflows/main/badge.svg

[bundle-size]: https://bundlejs.com/?q=micromark-core-commonmark

[bundle-size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-core-commonmark

[chat]: https://github.com/micromark/micromark/discussions

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[coc]: https://github.com/micromark/.github/blob/main/code-of-conduct.md

[construct]: https://github.com/micromark/micromark#constructs

[contributing]: https://github.com/micromark/.github/blob/main/contributing.md

[coverage]: https://codecov.io/github/micromark/micromark

[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark.svg

[disable]: https://github.com/micromark/micromark#case-turn-off-constructs

[downloads]: https://www.npmjs.com/package/micromark-core-commonmark

[downloads-badge]: https://img.shields.io/npm/dm/micromark-core-commonmark.svg

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[health]: https://github.com/micromark/.github

[license]: https://github.com/micromark/micromark/blob/main/license

[micromark]: https://github.com/micromark/micromark

[npm]: https://docs.npmjs.com/cli/install

[opencollective]: https://opencollective.com/unified

[securitymd]: https://github.com/micromark/.github/blob/main/security.md

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[support]: https://github.com/micromark/.github/blob/main/support.md

[typescript]: https://www.typescriptlang.org

---
_Source: https://npm.io/package/micromark-core-commonmark · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._