unified

Project: micromark/micromark

Package: micromark-core-commonmark@1.0.6

  1. Dependents: 0
  2. The CommonMark markdown constructs
  1. micromark 35
  2. commonmark 6

micromark-core-commonmark

Build Coverage Downloads Size Sponsors Backers Chat

The core CommonMark constructs needed to tokenize markdown. Some of these can be turned off, but they are often essential to markdown and weird things might happen.

Contents

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), 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.

Security

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