Project: syntax-tree/mdast-util-find-and-replace

Package: mdast-util-find-and-replace@2.2.1

  1. Dependents: 0
  2. mdast utility to find and replace text in a tree
  1. util 136
  2. markdown 136
  3. utility 132
  4. unist 128
  5. mdast 84
  6. mdast-util 31
  7. find 11
  8. replace 2


Build Coverage Downloads Size Sponsors Backers Chat

mdast utility to find and replace things.


What is this?

This package is a utility that lets you find patterns (string, RegExp) in text and replace them with nodes.

When should I use this?

This utility is typically useful when you have regexes and want to modify mdast. One example is when you have some form of “mentions” (such as /@([a-z][_a-z0-9])\b/gi) and want to create links to persons from them.

A similar package, hast-util-find-and-replace does the same but on hast.


This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install mdast-util-find-and-replace

In Deno with esm.sh:

import {findAndReplace} from 'https://esm.sh/mdast-util-find-and-replace@2'

In browsers with esm.sh:

<script type="module">
  import {findAndReplace} from 'https://esm.sh/mdast-util-find-and-replace@2?bundle'


import {u} from 'unist-builder'
import {inspect} from 'unist-util-inspect'
import {findAndReplace} from 'mdast-util-find-and-replace'

const tree = u('paragraph', [
  u('text', 'Some '),
  u('emphasis', [u('text', 'emphasis')]),
  u('text', ' and '),
  u('strong', [u('text', 'importance')]),
  u('text', '.')

findAndReplace(tree, [
  [/and/gi, 'or'],
  [/emphasis/gi, 'em'],
  [/importance/gi, 'strong'],
    function ($0) {
      return u('link', {url: '//example.com#' + $0}, [u('text', $0)])



├─0 link[1]
│   │ url: "//example.com#Some"
│   └─0 text "Some"
├─1 text " "
├─2 emphasis[1]
│   └─0 text "em"
├─3 text " "
├─4 text "or"
├─5 text " "
├─6 strong[1]
│   └─0 text "strong"
└─7 text "."


This package exports the identifier findAndReplace. There is no default export.

findAndReplace(tree, find, replace[, options])

Find patterns in a tree and replace them. The algorithm searches the tree in preorder for complete values in Text nodes. Partial matches are not supported.


The given tree (Node).


This package is fully typed with TypeScript. It exports the types Find, Replace, ReplaceFunction, FindAndReplaceTuple, FindAndReplaceSchema, FindAndReplaceList, RegExpMatchObject, and Options.


Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.


Use of mdast-util-find-and-replace does not involve hast or user content so there are no openings for cross-site scripting (XSS) attacks.


See contributing.md in syntax-tree/.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