[![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.
* What is this? * When should I use this? * Install * Use * API * Types * Compatibility * Security * Contribute * License
This package exposes the default constructs.
This package is useful when you are making your own micromark extensions.
This package is [ESM only][esm]. In Node.js (version 16+), install with [npm][]:
npm install micromark-core-commonmark
In Deno with [esm.sh][esmsh]:
import * as core from 'https://esm.sh/micromark-core-commonmark@1'
In browsers with [esm.sh][esmsh]:
import {autolink} from 'micromark-core-commonmark'console.log(autolink) // Do things with autolink.
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.
This package is fully typed with [TypeScript][]. It exports no additional types.
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.
This package is safe.
See [security.md][securitymd] in [micromark/.github][health] for how to
submit a security report.
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.
[MIT][license] © [Titus Wormer][author]
[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