Project: micromark/micromark

Package: micromark-util-decode-string@1.0.2

  1. micromark utility to decode markdown strings
  1. util 146
  2. utility 142
  3. micromark 37
  4. reference 14
  5. string 8
  6. character 7
  7. decode 2


Build Coverage Downloads Size Sponsors Backers Chat

micromark utility to decode markdown strings.


What is this?

This package exposes an algorithm to parse character escapes and character references.

When should I use this?

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


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

npm install micromark-util-decode-string

In Deno with esm.sh:

import {decodeString} from 'https://esm.sh/micromark-util-decode-string@1'

In browsers with esm.sh:

<script type="module">
  import {decodeString} from 'https://esm.sh/micromark-util-decode-string@1?bundle'


import {decodeString} from 'micromark-util-decode-string'

decodeString('a &semi; b') // 'a ; b'
decodeString('a \\; b') // 'a ; b'
decodeString('a ; b') // 'a ; b'


This module exports the identifier decodeString. There is no default export.


Decode markdown strings (which occur in places such as fenced code info strings, destinations, labels, and titles).

The “string” content type allows character escapes and -references. This decodes those.


Decoded value (string).


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-util-decode-string@^2, compatible with Node.js 16. This package works with micromark@^3.


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


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.


MIT © Titus Wormer