remark-stringify
remark plugin to add support for serializing to markdown.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Syntax
- Syntax tree
- Types
- Compatibility
- Security
- Contribute
- Sponsor
- License
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
options
(Options
, optional) — configuration
Returns
Nothing (undefined
).
Options
Configuration (TypeScript type).
Fields
bullet
('*'
,'+'
, or'-'
, default:'*'
) — marker to use for bullets of items in unordered listsbulletOther
('*'
,'+'
, or'-'
, default:'-'
whenbullet
is'*'
,'*'
otherwise) — marker to use in certain cases where the primary bullet doesn’t work; cannot be equal tobullet
bulletOrdered
('.'
or')'
, default:'.'
) — marker to use for bullets of items in ordered listscloseAtx
(boolean
, default:false
) — add the same number of number signs (#
) at the end of an ATX heading as the opening sequenceemphasis
('*'
or'_'
, default:'*'
) — marker to use for emphasisfence
('`'
or'~'
, default:'`'
) — marker to use for fenced codefences
(boolean
, default:true
) — use fenced code always; whenfalse
, uses fenced code if there is a language defined, if the code is empty, or if it starts or ends in blank lineshandlers
(Handlers
, optional) — handle particular nodes; seemdast-util-to-markdown
for more infoincrementListMarker
(boolean
, default:true
) — increment the counter of ordered lists itemsjoin
(Array<Join>
, optional) — how to join blocks; seemdast-util-to-markdown
for more infolistItemIndent
('mixed'
,'one'
, or'tab'
, default:'one'
) — how to indent the content of list items; either with the size of the bullet plus one space (when'one'
), a tab stop ('tab'
), or depending on the item and its parent list:'mixed'
uses'one'
if the item and list are tight and'tab'
otherwisequote
('"'
or"'"
, default:'"'
) — marker to use for titlesresourceLink
(boolean
, default:false
) — always use resource links ([text](url)
); whenfalse
, uses autolinks (<https://example.com>
) when possiblerule
('*'
,'-'
, or'_'
, default:'*'
) — marker to use for thematic breaksruleRepetition
(number
, default:3
, min:3
) — number of markers to use for thematic breaksruleSpaces
(boolean
, default:false
) — add spaces between markers in thematic breakssetext
(boolean
, default:false
) — use setext headings when possible; whentrue
, uses setext headings (heading\n=======
) for non-empty rank 1 or 2 headingsstrong
('*'
or'_'
, default:'*'
) — marker to use for strongtightDefinitions
(boolean
, default:false
) — join definitions without a blank lineunsafe
(Array<Unsafe>
, optional) — schemas that define when characters cannot occur; seemdast-util-to-markdown
for more info
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.
Sponsor
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? |