unified

Project: remarkjs/remark

Package: remark-stringify@10.0.2

  1. remark plugin to add support for serializing markdown
  1. remark 213
  2. unified 180
  3. markdown 153
  4. plugin 137
  5. mdast 88
  6. remark-plugin 81
  7. tree 44
  8. ast 37
  9. syntax 28
  10. stringify 18
  11. compile 13
  12. serialize 12
  13. abstract 10

remark-stringify

Build Coverage Downloads Size Sponsors Backers Chat

remark plugin to add support for serializing to markdown.

Contents

What is this?

This package is a unified (remark) plugin that defines how to take a syntax tree as input and turn it into serialized markdown. When it’s used, markdown is serialized as the final result.

See the monorepo readme for info on what the remark ecosystem is.

When should I use this?

This plugin adds support to unified for serializing markdown. If you also need to parse markdown, you can alternatively use remark, which combines unified, remark-parse, and this plugin.

If you don’t use plugins and have access to a syntax tree, you can directly use mdast-util-to-markdown, which is used inside this plugin. remark focusses on making it easier to transform content by abstracting these internals away.

You can combine this plugin with other plugins to add syntax extensions. Notable examples that deeply integrate with it are remark-gfm, remark-mdx, remark-frontmatter, remark-math, and remark-directive. You can also use any other remark plugin before remark-stringify.

Install

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

npm install remark-stringify

In Deno with esm.sh:

import remarkStringify from 'https://esm.sh/remark-stringify@11'

In browsers with esm.sh:

<script type="module">
  import remarkStringify from 'https://esm.sh/remark-stringify@11?bundle'
</script>

Use

Say we have the following module example.js:

import rehypeParse from 'rehype-parse'
import rehypeRemark from 'rehype-remark'
import remarkStringify from 'remark-stringify'
import {unified} from 'unified'

const doc = `
<h1>Uranus</h1>
<p><b>Uranus</b> is the seventh
<a href="/wiki/Planet" title="Planet">planet</a> from the Sun and is a gaseous
cyan <a href="/wiki/Ice_giant" title="Ice giant">ice giant</a>.</p>
`

const file = await unified()
  .use(rehypeParse)
  .use(rehypeRemark)
  .use(remarkStringify)
  .process(doc)

console.log(String(file))

…then running node example.js yields:

# Uranus

**Uranus** is the seventh [planet](/wiki/Planet "Planet") from the Sun and is a gaseous cyan [ice giant](/wiki/Ice_giant "Ice giant").

API

This package exports no identifiers. The default export is remarkStringify.

unified().use(remarkStringify[, options])

Add support for serializing to markdown.

Parameters
Returns

Nothing (undefined).

Options

Configuration (TypeScript type).

Fields

Syntax

Markdown is serialized according to CommonMark but care is taken to format in a way that works with most markdown parsers. Other plugins can add support for syntax extensions.

Syntax tree

The syntax tree used in remark is mdast.

Types

This package is fully typed with TypeScript. It exports the additional type Options.

It also registers Settings with unified. If you’re passing options with .data('settings', …), make sure to import this package somewhere in your types, as that registers the fields.

/// <reference types="remark-stringify" />

import {unified} from 'unified'

// @ts-expect-error: `thisDoesNotExist` is not a valid option.
unified().data('settings', {thisDoesNotExist: false})

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, remark-stringify@^11, compatible with Node.js 16.

Security

Use of remark-stringify is safe.

Use of remark plugins can open you up to attacks. Carefully assess each plugin and the risks involved in using them.

For info on how to submit a report, see our security policy.

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help. Join us in Discussions to chat with the community and contributors.

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

Support this effort and give back by sponsoring on OpenCollective!

Vercel

Motif

HashiCorp

GitBook

Gatsby

Netlify

Coinbase

ThemeIsle

Expo

Boost Note

Markdown Space

Holloway


You?

License

MIT © Titus Wormer