remark-breaks
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatremark plugin to support hard breaks without needing spaces or escapes (turns enters into
<br>
s).Contents
* [`unified().use(remarkBreaks)`](#unifieduseremarkbreaks)
What is this?
This package is a unified (remark) plugin to turn soft line endings (enters) into hard breaks (<br>
s)When should I use this?
This plugin is useful if you want to display user content closer to how it was authored, because when a user includes a line ending, it’ll show as such. GitHub does this in a few places (comments, issues, PRs, and releases), but it’s not semantic according to HTML and not compliant to markdown. Markdown already has two ways to include hard breaks, namely trailing spaces and escapes (note that␠
represents a normal space):lorem␠␠
ipsum
lorem\
ipsum
Both will turn into
<br>
s.
If you control who authors content or can document how markdown works, it’s
recommended to use escapes instead.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install remark-breaks
In Deno with
esm.sh
esmsh:import remarkBreaks from 'https://esm.sh/remark-breaks@4'
In browsers with
esm.sh
esmsh:<script type="module">
import remarkBreaks from 'https://esm.sh/remark-breaks@4?bundle'
</script>
Use
Say we have the following fileexample.md
(note: there are no spaces after
a
):Mars is
the fourth planet
…and a module
example.js
:import rehypeStringify from 'rehype-stringify'
import remarkBreaks from 'remark-breaks'
import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype'
import {read} from 'to-vfile'
import {unified} from 'unified'
const file = await unified()
.use(remarkParse)
.use(remarkBreaks)
.use(remarkRehype)
.use(rehypeStringify)
.process(await read('example.md'))
console.log(String(file))
…then running
node example.js
yields:<p>Mars is<br>
the fourth planet</p>
👉 Note: Withoutremark-breaks
, you’d get:<p>Mars is the fourth planet</p>
API
This package exports no identifiers. The default export isremarkBreaks
api-remark-breaks.unified().use(remarkBreaks)
Support hard breaks without needing spaces or escapes (turns enters into
<br>
s).Parameters
There are no parameters.Returns
Transform (Transformer
unified-transformer).Syntax
This plugin looks for markdown line endings (\r
, \n
, and \r\n
) preceded
by zero or more spaces and tabs.Syntax tree
This plugin adds mdastBreak
mdast-break nodes to the syntax tree.
These are the same nodes that represent breaks with spaces or escapes.Types
This package is fully typed with TypeScript. It exports no additional types.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-breaks@^4
,
compatible with Node.js 16.This plugin works with
unified
version 6+ and remark
version 7+.Security
Use ofremark-breaks
does not involve rehype (hast) or user
content so there are no openings for cross-site scripting (XSS)wiki-xss
attacks.Related
— support GFM (autolink literals, footnotes, strikethrough, tables,
tasklists)
— link references to commits, issues, and users, in the same way that
GitHub does
— support directives
— support frontmatter (YAML, TOML, and more)
— support math
Contribute
Seecontributing.md
contributing in remarkjs/.github
health for ways
to get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.